_ Git - ldk-java/blob - src/main/java/org/ldk/structs/FailureCode.java

   1 package org.ldk.structs;
   2
   3 import org.ldk.impl.bindings;
   4 import org.ldk.enums.*;
   5 import org.ldk.util.*;
   6 import java.util.Arrays;
   7 import java.lang.ref.Reference;
   8 import javax.annotation.Nullable;
   9
  10
  11 /**
  12  * This enum is used to specify which error data to send to peers when failing back an HTLC
  13  * using [`ChannelManager::fail_htlc_backwards_with_reason`].
  14  *
  15  * For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
  16  */
  17 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  18 public class FailureCode extends CommonBase {
  19         private FailureCode(Object _dummy, long ptr) { super(ptr); }
  20         @Override @SuppressWarnings("deprecation")
  21         protected void finalize() throws Throwable {
  22                 super.finalize();
  23                 if (ptr != 0) { bindings.FailureCode_free(ptr); }
  24         }
  25         static FailureCode constr_from_ptr(long ptr) {
  26                 bindings.LDKFailureCode raw_val = bindings.LDKFailureCode_ref_from_ptr(ptr);
  27                 if (raw_val.getClass() == bindings.LDKFailureCode.TemporaryNodeFailure.class) {
  28                         return new TemporaryNodeFailure(ptr, (bindings.LDKFailureCode.TemporaryNodeFailure)raw_val);
  29                 }
  30                 if (raw_val.getClass() == bindings.LDKFailureCode.RequiredNodeFeatureMissing.class) {
  31                         return new RequiredNodeFeatureMissing(ptr, (bindings.LDKFailureCode.RequiredNodeFeatureMissing)raw_val);
  32                 }
  33                 if (raw_val.getClass() == bindings.LDKFailureCode.IncorrectOrUnknownPaymentDetails.class) {
  34                         return new IncorrectOrUnknownPaymentDetails(ptr, (bindings.LDKFailureCode.IncorrectOrUnknownPaymentDetails)raw_val);
  35                 }
  36                 if (raw_val.getClass() == bindings.LDKFailureCode.InvalidOnionPayload.class) {
  37                         return new InvalidOnionPayload(ptr, (bindings.LDKFailureCode.InvalidOnionPayload)raw_val);
  38                 }
  39                 assert false; return null; // Unreachable without extending the (internal) bindings interface
  40         }
  41
  42         /**
  43          * We had a temporary error processing the payment. Useful if no other error codes fit
  44          * and you want to indicate that the payer may want to retry.
  45          */
  46         public final static class TemporaryNodeFailure extends FailureCode {
  47                 private TemporaryNodeFailure(long ptr, bindings.LDKFailureCode.TemporaryNodeFailure obj) {
  48                         super(null, ptr);
  49                 }
  50         }
  51         /**
  52          * We have a required feature which was not in this onion. For example, you may require
  53          * some additional metadata that was not provided with this payment.
  54          */
  55         public final static class RequiredNodeFeatureMissing extends FailureCode {
  56                 private RequiredNodeFeatureMissing(long ptr, bindings.LDKFailureCode.RequiredNodeFeatureMissing obj) {
  57                         super(null, ptr);
  58                 }
  59         }
  60         /**
  61          * You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
  62          * the HTLC is too close to the current block height for safe handling.
  63          * Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
  64          * equivalent to calling [`ChannelManager::fail_htlc_backwards`].
  65          */
  66         public final static class IncorrectOrUnknownPaymentDetails extends FailureCode {
  67                 private IncorrectOrUnknownPaymentDetails(long ptr, bindings.LDKFailureCode.IncorrectOrUnknownPaymentDetails obj) {
  68                         super(null, ptr);
  69                 }
  70         }
  71         /**
  72          * We failed to process the payload after the onion was decrypted. You may wish to
  73          * use this when receiving custom HTLC TLVs with even type numbers that you don't recognize.
  74          *
  75          * If available, the tuple data may include the type number and byte offset in the
  76          * decrypted byte stream where the failure occurred.
  77          */
  78         public final static class InvalidOnionPayload extends FailureCode {
  79                 public final org.ldk.structs.Option_C2Tuple_u64u16ZZ invalid_onion_payload;
  80                 private InvalidOnionPayload(long ptr, bindings.LDKFailureCode.InvalidOnionPayload obj) {
  81                         super(null, ptr);
  82                         long invalid_onion_payload = obj.invalid_onion_payload;
  83                         org.ldk.structs.Option_C2Tuple_u64u16ZZ invalid_onion_payload_hu_conv = org.ldk.structs.Option_C2Tuple_u64u16ZZ.constr_from_ptr(invalid_onion_payload);
  84                         if (invalid_onion_payload_hu_conv != null) { invalid_onion_payload_hu_conv.ptrs_to.add(this); };
  85                         this.invalid_onion_payload = invalid_onion_payload_hu_conv;
  86                 }
  87         }
  88         long clone_ptr() {
  89                 long ret = bindings.FailureCode_clone_ptr(this.ptr);
  90                 Reference.reachabilityFence(this);
  91                 return ret;
  92         }
  93
  94         /**
  95          * Creates a copy of the FailureCode
  96          */
  97         public FailureCode clone() {
  98                 long ret = bindings.FailureCode_clone(this.ptr);
  99                 Reference.reachabilityFence(this);
 100                 if (ret >= 0 && ret <= 4096) { return null; }
 101                 org.ldk.structs.FailureCode ret_hu_conv = org.ldk.structs.FailureCode.constr_from_ptr(ret);
 102                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
 103                 return ret_hu_conv;
 104         }
 105
 106         /**
 107          * Utility method to constructs a new TemporaryNodeFailure-variant FailureCode
 108          */
 109         public static FailureCode temporary_node_failure() {
 110                 long ret = bindings.FailureCode_temporary_node_failure();
 111                 if (ret >= 0 && ret <= 4096) { return null; }
 112                 org.ldk.structs.FailureCode ret_hu_conv = org.ldk.structs.FailureCode.constr_from_ptr(ret);
 113                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
 114                 return ret_hu_conv;
 115         }
 116
 117         /**
 118          * Utility method to constructs a new RequiredNodeFeatureMissing-variant FailureCode
 119          */
 120         public static FailureCode required_node_feature_missing() {
 121                 long ret = bindings.FailureCode_required_node_feature_missing();
 122                 if (ret >= 0 && ret <= 4096) { return null; }
 123                 org.ldk.structs.FailureCode ret_hu_conv = org.ldk.structs.FailureCode.constr_from_ptr(ret);
 124                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
 125                 return ret_hu_conv;
 126         }
 127
 128         /**
 129          * Utility method to constructs a new IncorrectOrUnknownPaymentDetails-variant FailureCode
 130          */
 131         public static FailureCode incorrect_or_unknown_payment_details() {
 132                 long ret = bindings.FailureCode_incorrect_or_unknown_payment_details();
 133                 if (ret >= 0 && ret <= 4096) { return null; }
 134                 org.ldk.structs.FailureCode ret_hu_conv = org.ldk.structs.FailureCode.constr_from_ptr(ret);
 135                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
 136                 return ret_hu_conv;
 137         }
 138
 139         /**
 140          * Utility method to constructs a new InvalidOnionPayload-variant FailureCode
 141          */
 142         public static FailureCode invalid_onion_payload(org.ldk.structs.Option_C2Tuple_u64u16ZZ a) {
 143                 long ret = bindings.FailureCode_invalid_onion_payload(a.ptr);
 144                 Reference.reachabilityFence(a);
 145                 if (ret >= 0 && ret <= 4096) { return null; }
 146                 org.ldk.structs.FailureCode ret_hu_conv = org.ldk.structs.FailureCode.constr_from_ptr(ret);
 147                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
 148                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(a); };
 149                 return ret_hu_conv;
 150         }
 151
 152 }