1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
12 * Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
13 * These include payments that have yet to find a successful path, or have unresolved HTLCs.
15 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
16 public class RecentPaymentDetails extends CommonBase {
17 private RecentPaymentDetails(Object _dummy, long ptr) { super(ptr); }
18 @Override @SuppressWarnings("deprecation")
19 protected void finalize() throws Throwable {
21 if (ptr != 0) { bindings.RecentPaymentDetails_free(ptr); }
23 static RecentPaymentDetails constr_from_ptr(long ptr) {
24 bindings.LDKRecentPaymentDetails raw_val = bindings.LDKRecentPaymentDetails_ref_from_ptr(ptr);
25 if (raw_val.getClass() == bindings.LDKRecentPaymentDetails.Pending.class) {
26 return new Pending(ptr, (bindings.LDKRecentPaymentDetails.Pending)raw_val);
28 if (raw_val.getClass() == bindings.LDKRecentPaymentDetails.Fulfilled.class) {
29 return new Fulfilled(ptr, (bindings.LDKRecentPaymentDetails.Fulfilled)raw_val);
31 if (raw_val.getClass() == bindings.LDKRecentPaymentDetails.Abandoned.class) {
32 return new Abandoned(ptr, (bindings.LDKRecentPaymentDetails.Abandoned)raw_val);
34 assert false; return null; // Unreachable without extending the (internal) bindings interface
38 * When a payment is still being sent and awaiting successful delivery.
40 public final static class Pending extends RecentPaymentDetails {
42 * Hash of the payment that is currently being sent but has yet to be fulfilled or
45 public final byte[] payment_hash;
47 * Total amount (in msat, excluding fees) across all paths for this payment,
48 * not just the amount currently inflight.
50 public final long total_msat;
51 private Pending(long ptr, bindings.LDKRecentPaymentDetails.Pending obj) {
53 this.payment_hash = obj.payment_hash;
54 this.total_msat = obj.total_msat;
58 * When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
59 * been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
60 * payment is removed from tracking.
62 public final static class Fulfilled extends RecentPaymentDetails {
64 * Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
65 * made before LDK version 0.0.104.
67 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
69 @Nullable public final byte[] payment_hash;
70 private Fulfilled(long ptr, bindings.LDKRecentPaymentDetails.Fulfilled obj) {
72 this.payment_hash = obj.payment_hash;
76 * After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
77 * abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
78 * pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
80 public final static class Abandoned extends RecentPaymentDetails {
82 * Hash of the payment that we have given up trying to send.
84 public final byte[] payment_hash;
85 private Abandoned(long ptr, bindings.LDKRecentPaymentDetails.Abandoned obj) {
87 this.payment_hash = obj.payment_hash;
91 long ret = bindings.RecentPaymentDetails_clone_ptr(this.ptr);
92 Reference.reachabilityFence(this);
97 * Creates a copy of the RecentPaymentDetails
99 public RecentPaymentDetails clone() {
100 long ret = bindings.RecentPaymentDetails_clone(this.ptr);
101 Reference.reachabilityFence(this);
102 if (ret >= 0 && ret <= 4096) { return null; }
103 org.ldk.structs.RecentPaymentDetails ret_hu_conv = org.ldk.structs.RecentPaymentDetails.constr_from_ptr(ret);
104 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
109 * Utility method to constructs a new Pending-variant RecentPaymentDetails
111 public static RecentPaymentDetails pending(byte[] payment_hash, long total_msat) {
112 long ret = bindings.RecentPaymentDetails_pending(InternalUtils.check_arr_len(payment_hash, 32), total_msat);
113 Reference.reachabilityFence(payment_hash);
114 Reference.reachabilityFence(total_msat);
115 if (ret >= 0 && ret <= 4096) { return null; }
116 org.ldk.structs.RecentPaymentDetails ret_hu_conv = org.ldk.structs.RecentPaymentDetails.constr_from_ptr(ret);
117 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
122 * Utility method to constructs a new Fulfilled-variant RecentPaymentDetails
124 public static RecentPaymentDetails fulfilled(byte[] payment_hash) {
125 long ret = bindings.RecentPaymentDetails_fulfilled(InternalUtils.check_arr_len(payment_hash, 32));
126 Reference.reachabilityFence(payment_hash);
127 if (ret >= 0 && ret <= 4096) { return null; }
128 org.ldk.structs.RecentPaymentDetails ret_hu_conv = org.ldk.structs.RecentPaymentDetails.constr_from_ptr(ret);
129 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
134 * Utility method to constructs a new Abandoned-variant RecentPaymentDetails
136 public static RecentPaymentDetails abandoned(byte[] payment_hash) {
137 long ret = bindings.RecentPaymentDetails_abandoned(InternalUtils.check_arr_len(payment_hash, 32));
138 Reference.reachabilityFence(payment_hash);
139 if (ret >= 0 && ret <= 4096) { return null; }
140 org.ldk.structs.RecentPaymentDetails ret_hu_conv = org.ldk.structs.RecentPaymentDetails.constr_from_ptr(ret);
141 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };