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;
11 * A trait defining behavior of an [`Invoice`] payer.
13 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
14 public class Payer extends CommonBase {
15 final bindings.LDKPayer bindings_instance;
16 Payer(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }
17 private Payer(bindings.LDKPayer arg) {
18 super(bindings.LDKPayer_new(arg));
19 this.ptrs_to.add(arg);
20 this.bindings_instance = arg;
22 @Override @SuppressWarnings("deprecation")
23 protected void finalize() throws Throwable {
24 if (ptr != 0) { bindings.Payer_free(ptr); } super.finalize();
27 public static interface PayerInterface {
29 * Returns the payer's node id.
33 * Returns the payer's channels.
35 ChannelDetails[] first_hops();
37 * Sends a payment over the Lightning Network using the given [`Route`].
39 * Note that payment_secret (or a relevant inner pointer) may be NULL or all-0s to represent None
41 Result_PaymentIdPaymentSendFailureZ send_payment(Route route, byte[] payment_hash, byte[] payment_secret);
43 * Sends a spontaneous payment over the Lightning Network using the given [`Route`].
45 Result_PaymentIdPaymentSendFailureZ send_spontaneous_payment(Route route, byte[] payment_preimage);
47 * Retries a failed payment path for the [`PaymentId`] using the given [`Route`].
49 Result_NonePaymentSendFailureZ retry_payment(Route route, byte[] payment_id);
51 * Signals that no further retries for the given payment will occur.
53 void abandon_payment(byte[] payment_id);
55 private static class LDKPayerHolder { Payer held; }
56 public static Payer new_impl(PayerInterface arg) {
57 final LDKPayerHolder impl_holder = new LDKPayerHolder();
58 impl_holder.held = new Payer(new bindings.LDKPayer() {
59 @Override public byte[] node_id() {
60 byte[] ret = arg.node_id();
61 byte[] result = InternalUtils.check_arr_len(ret, 33);
64 @Override public long[] first_hops() {
65 ChannelDetails[] ret = arg.first_hops();
66 long[] result = ret != null ? Arrays.stream(ret).mapToLong(ret_conv_16 -> ret_conv_16 == null ? 0 : ret_conv_16.clone_ptr()).toArray() : null;
69 @Override public long send_payment(long route, byte[] payment_hash, byte[] payment_secret) {
70 Route route_hu_conv = null; if (route < 0 || route > 4096) { route_hu_conv = new Route(null, route); }
71 Result_PaymentIdPaymentSendFailureZ ret = arg.send_payment(route_hu_conv, payment_hash, payment_secret);
72 long result = ret == null ? 0 : ret.clone_ptr();
75 @Override public long send_spontaneous_payment(long route, byte[] payment_preimage) {
76 Route route_hu_conv = null; if (route < 0 || route > 4096) { route_hu_conv = new Route(null, route); }
77 Result_PaymentIdPaymentSendFailureZ ret = arg.send_spontaneous_payment(route_hu_conv, payment_preimage);
78 long result = ret == null ? 0 : ret.clone_ptr();
81 @Override public long retry_payment(long route, byte[] payment_id) {
82 Route route_hu_conv = null; if (route < 0 || route > 4096) { route_hu_conv = new Route(null, route); }
83 Result_NonePaymentSendFailureZ ret = arg.retry_payment(route_hu_conv, payment_id);
84 long result = ret == null ? 0 : ret.clone_ptr();
87 @Override public void abandon_payment(byte[] payment_id) {
88 arg.abandon_payment(payment_id);
91 return impl_holder.held;
94 * Returns the payer's node id.
96 public byte[] node_id() {
97 byte[] ret = bindings.Payer_node_id(this.ptr);
98 Reference.reachabilityFence(this);
103 * Returns the payer's channels.
105 public ChannelDetails[] first_hops() {
106 long[] ret = bindings.Payer_first_hops(this.ptr);
107 Reference.reachabilityFence(this);
108 int ret_conv_16_len = ret.length;
109 ChannelDetails[] ret_conv_16_arr = new ChannelDetails[ret_conv_16_len];
110 for (int q = 0; q < ret_conv_16_len; q++) {
111 long ret_conv_16 = ret[q];
112 ChannelDetails ret_conv_16_hu_conv = null; if (ret_conv_16 < 0 || ret_conv_16 > 4096) { ret_conv_16_hu_conv = new ChannelDetails(null, ret_conv_16); }
113 ret_conv_16_hu_conv.ptrs_to.add(this);
114 ret_conv_16_arr[q] = ret_conv_16_hu_conv;
116 return ret_conv_16_arr;
120 * Sends a payment over the Lightning Network using the given [`Route`].
122 * Note that payment_secret (or a relevant inner pointer) may be NULL or all-0s to represent None
124 public Result_PaymentIdPaymentSendFailureZ send_payment(Route route, byte[] payment_hash, @Nullable byte[] payment_secret) {
125 long ret = bindings.Payer_send_payment(this.ptr, route == null ? 0 : route.ptr & ~1, InternalUtils.check_arr_len(payment_hash, 32), InternalUtils.check_arr_len(payment_secret, 32));
126 Reference.reachabilityFence(this);
127 Reference.reachabilityFence(route);
128 Reference.reachabilityFence(payment_hash);
129 Reference.reachabilityFence(payment_secret);
130 if (ret >= 0 && ret <= 4096) { return null; }
131 Result_PaymentIdPaymentSendFailureZ ret_hu_conv = Result_PaymentIdPaymentSendFailureZ.constr_from_ptr(ret);
132 this.ptrs_to.add(route);
137 * Sends a spontaneous payment over the Lightning Network using the given [`Route`].
139 public Result_PaymentIdPaymentSendFailureZ send_spontaneous_payment(Route route, byte[] payment_preimage) {
140 long ret = bindings.Payer_send_spontaneous_payment(this.ptr, route == null ? 0 : route.ptr & ~1, InternalUtils.check_arr_len(payment_preimage, 32));
141 Reference.reachabilityFence(this);
142 Reference.reachabilityFence(route);
143 Reference.reachabilityFence(payment_preimage);
144 if (ret >= 0 && ret <= 4096) { return null; }
145 Result_PaymentIdPaymentSendFailureZ ret_hu_conv = Result_PaymentIdPaymentSendFailureZ.constr_from_ptr(ret);
146 this.ptrs_to.add(route);
151 * Retries a failed payment path for the [`PaymentId`] using the given [`Route`].
153 public Result_NonePaymentSendFailureZ retry_payment(Route route, byte[] payment_id) {
154 long ret = bindings.Payer_retry_payment(this.ptr, route == null ? 0 : route.ptr & ~1, InternalUtils.check_arr_len(payment_id, 32));
155 Reference.reachabilityFence(this);
156 Reference.reachabilityFence(route);
157 Reference.reachabilityFence(payment_id);
158 if (ret >= 0 && ret <= 4096) { return null; }
159 Result_NonePaymentSendFailureZ ret_hu_conv = Result_NonePaymentSendFailureZ.constr_from_ptr(ret);
160 this.ptrs_to.add(route);
165 * Signals that no further retries for the given payment will occur.
167 public void abandon_payment(byte[] payment_id) {
168 bindings.Payer_abandon_payment(this.ptr, InternalUtils.check_arr_len(payment_id, 32));
169 Reference.reachabilityFence(this);
170 Reference.reachabilityFence(payment_id);