1 package org.ldk.structs;
2 import org.ldk.impl.bindings;
3 import java.util.Arrays;
4 import org.ldk.enums.*;
6 public class UtilMethods {
8 * Creates a digital signature of a message given a SecretKey, like the node's secret.
9 * A receiver knowing the PublicKey (e.g. the node's id) and the message can be sure that the signature was generated by the caller.
10 * Signatures are EC recoverable, meaning that given the message and the signature the PublicKey of the signer can be extracted.
12 public static Result_StringErrorZ sign(byte[] msg, byte[] sk) {
13 long ret = bindings.sign(msg, sk);
14 if (ret < 1024) { return null; }
15 Result_StringErrorZ ret_hu_conv = Result_StringErrorZ.constr_from_ptr(ret);
20 * Recovers the PublicKey of the signer of the message given the message and the signature.
22 public static Result_PublicKeyErrorZ recover_pk(byte[] msg, String sig) {
23 long ret = bindings.recover_pk(msg, sig);
24 if (ret < 1024) { return null; }
25 Result_PublicKeyErrorZ ret_hu_conv = Result_PublicKeyErrorZ.constr_from_ptr(ret);
30 * Verifies a message was signed by a PrivateKey that derives to a given PublicKey, given a message, a signature,
33 public static boolean verify(byte[] msg, String sig, byte[] pk) {
34 boolean ret = bindings.verify(msg, sig, pk);
39 * Read a C2Tuple_BlockHashChannelMonitorZ from a byte array, created by C2Tuple_BlockHashChannelMonitorZ_write
41 public static Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ BlockHashChannelMonitorZ_read(byte[] ser, KeysInterface arg) {
42 long ret = bindings.C2Tuple_BlockHashChannelMonitorZ_read(ser, arg == null ? 0 : arg.ptr);
43 if (ret < 1024) { return null; }
44 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ ret_hu_conv = Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.constr_from_ptr(ret);
45 ret_hu_conv.ptrs_to.add(arg);
50 * Read a C2Tuple_BlockHashChannelManagerZ from a byte array, created by C2Tuple_BlockHashChannelManagerZ_write
52 public static Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ BlockHashChannelManagerZ_read(byte[] ser, KeysInterface arg_keys_manager, FeeEstimator arg_fee_estimator, Watch arg_chain_monitor, BroadcasterInterface arg_tx_broadcaster, Logger arg_logger, UserConfig arg_default_config, ChannelMonitor[] arg_channel_monitors) {
53 long ret = bindings.C2Tuple_BlockHashChannelManagerZ_read(ser, bindings.ChannelManagerReadArgs_new(arg_keys_manager == null ? 0 : arg_keys_manager.ptr, arg_fee_estimator == null ? 0 : arg_fee_estimator.ptr, arg_chain_monitor == null ? 0 : arg_chain_monitor.ptr, arg_tx_broadcaster == null ? 0 : arg_tx_broadcaster.ptr, arg_logger == null ? 0 : arg_logger.ptr, arg_default_config == null ? 0 : arg_default_config.ptr & ~1, Arrays.stream(arg_channel_monitors).mapToLong(arg_channel_monitors_conv_16 -> arg_channel_monitors_conv_16 == null ? 0 : arg_channel_monitors_conv_16.ptr & ~1).toArray()));
54 if (ret < 1024) { return null; }
55 Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ ret_hu_conv = Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.constr_from_ptr(ret);
56 ret_hu_conv.ptrs_to.add(arg_keys_manager);
57 ret_hu_conv.ptrs_to.add(arg_fee_estimator);
58 ret_hu_conv.ptrs_to.add(arg_chain_monitor);
59 ret_hu_conv.ptrs_to.add(arg_tx_broadcaster);
60 ret_hu_conv.ptrs_to.add(arg_logger);
61 ret_hu_conv.ptrs_to.add(arg_default_config);
62 /* TODO 2 ChannelMonitor */;
67 * Build the commitment secret from the seed and the commitment number
69 public static byte[] build_commitment_secret(byte[] commitment_seed, long idx) {
70 byte[] ret = bindings.build_commitment_secret(commitment_seed, idx);
75 * Derives a per-commitment-transaction private key (eg an htlc key or delayed_payment key)
76 * from the base secret and the per_commitment_point.
78 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
79 * generated (ie our own).
81 public static Result_SecretKeyErrorZ derive_private_key(byte[] per_commitment_point, byte[] base_secret) {
82 long ret = bindings.derive_private_key(per_commitment_point, base_secret);
83 if (ret < 1024) { return null; }
84 Result_SecretKeyErrorZ ret_hu_conv = Result_SecretKeyErrorZ.constr_from_ptr(ret);
89 * Derives a per-commitment-transaction public key (eg an htlc key or a delayed_payment key)
90 * from the base point and the per_commitment_key. This is the public equivalent of
91 * derive_private_key - using only public keys to derive a public key instead of private keys.
93 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
94 * generated (ie our own).
96 public static Result_PublicKeyErrorZ derive_public_key(byte[] per_commitment_point, byte[] base_point) {
97 long ret = bindings.derive_public_key(per_commitment_point, base_point);
98 if (ret < 1024) { return null; }
99 Result_PublicKeyErrorZ ret_hu_conv = Result_PublicKeyErrorZ.constr_from_ptr(ret);
104 * Derives a per-commitment-transaction revocation key from its constituent parts.
106 * Only the cheating participant owns a valid witness to propagate a revoked
107 * commitment transaction, thus per_commitment_secret always come from cheater
108 * and revocation_base_secret always come from punisher, which is the broadcaster
109 * of the transaction spending with this key knowledge.
111 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
112 * generated (ie our own).
114 public static Result_SecretKeyErrorZ derive_private_revocation_key(byte[] per_commitment_secret, byte[] countersignatory_revocation_base_secret) {
115 long ret = bindings.derive_private_revocation_key(per_commitment_secret, countersignatory_revocation_base_secret);
116 if (ret < 1024) { return null; }
117 Result_SecretKeyErrorZ ret_hu_conv = Result_SecretKeyErrorZ.constr_from_ptr(ret);
122 * Derives a per-commitment-transaction revocation public key from its constituent parts. This is
123 * the public equivalend of derive_private_revocation_key - using only public keys to derive a
124 * public key instead of private keys.
126 * Only the cheating participant owns a valid witness to propagate a revoked
127 * commitment transaction, thus per_commitment_point always come from cheater
128 * and revocation_base_point always come from punisher, which is the broadcaster
129 * of the transaction spending with this key knowledge.
131 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
132 * generated (ie our own).
134 public static Result_PublicKeyErrorZ derive_public_revocation_key(byte[] per_commitment_point, byte[] countersignatory_revocation_base_point) {
135 long ret = bindings.derive_public_revocation_key(per_commitment_point, countersignatory_revocation_base_point);
136 if (ret < 1024) { return null; }
137 Result_PublicKeyErrorZ ret_hu_conv = Result_PublicKeyErrorZ.constr_from_ptr(ret);
142 * A script either spendable by the revocation
143 * key or the broadcaster_delayed_payment_key and satisfying the relative-locktime OP_CSV constrain.
144 * Encumbering a `to_holder` output on a commitment transaction or 2nd-stage HTLC transactions.
146 public static byte[] get_revokeable_redeemscript(byte[] revocation_key, short contest_delay, byte[] broadcaster_delayed_payment_key) {
147 byte[] ret = bindings.get_revokeable_redeemscript(revocation_key, contest_delay, broadcaster_delayed_payment_key);
152 * Gets the witness redeemscript for an HTLC output in a commitment transaction. Note that htlc
153 * does not need to have its previous_output_index filled.
155 public static byte[] get_htlc_redeemscript(HTLCOutputInCommitment htlc, TxCreationKeys keys) {
156 byte[] ret = bindings.get_htlc_redeemscript(htlc == null ? 0 : htlc.ptr & ~1, keys == null ? 0 : keys.ptr & ~1);
157 // this.ptrs_to.add(htlc);
158 // this.ptrs_to.add(keys);
163 * Gets the redeemscript for a funding output from the two funding public keys.
164 * Note that the order of funding public keys does not matter.
166 public static byte[] make_funding_redeemscript(byte[] broadcaster, byte[] countersignatory) {
167 byte[] ret = bindings.make_funding_redeemscript(broadcaster, countersignatory);
172 * Builds an unsigned HTLC-Success or HTLC-Timeout transaction from the given channel and HTLC
173 * parameters. This is used by [`TrustedCommitmentTransaction::get_htlc_sigs`] to fetch the
174 * transaction which needs signing, and can be used to construct an HTLC transaction which is
175 * broadcastable given a counterparty HTLC signature.
177 * Panics if htlc.transaction_output_index.is_none() (as such HTLCs do not appear in the
178 * commitment transaction).
180 public static byte[] build_htlc_transaction(byte[] commitment_txid, int feerate_per_kw, short contest_delay, HTLCOutputInCommitment htlc, byte[] broadcaster_delayed_payment_key, byte[] revocation_key) {
181 byte[] ret = bindings.build_htlc_transaction(commitment_txid, feerate_per_kw, contest_delay, htlc == null ? 0 : htlc.ptr & ~1, broadcaster_delayed_payment_key, revocation_key);
182 // this.ptrs_to.add(htlc);
187 * Commitment transaction numbers which appear in the transactions themselves are XOR'd with a
188 * shared secret first. This prevents on-chain observers from discovering how many commitment
189 * transactions occurred in a channel before it was closed.
191 * This function gets the shared secret from relevant channel public keys and can be used to
192 * \"decrypt\" the commitment transaction number given a commitment transaction on-chain.
194 public static long get_commitment_transaction_number_obscure_factor(byte[] broadcaster_payment_basepoint, byte[] countersignatory_payment_basepoint, boolean outbound_from_broadcaster) {
195 long ret = bindings.get_commitment_transaction_number_obscure_factor(broadcaster_payment_basepoint, countersignatory_payment_basepoint, outbound_from_broadcaster);
200 * Gets a keysend route from us (payer) to the given target node (payee). This is needed because
201 * keysend payments do not have an invoice from which to pull the payee's supported features, which
202 * makes it tricky to otherwise supply the `payee_features` parameter of `get_route`.
204 * Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None
206 public static Result_RouteLightningErrorZ get_keysend_route(byte[] our_node_id, NetworkGraph network, byte[] payee, @Nullable ChannelDetails[] first_hops, RouteHint[] last_hops, long final_value_msat, int final_cltv, Logger logger) {
207 long ret = bindings.get_keysend_route(our_node_id, network == null ? 0 : network.ptr & ~1, payee, Arrays.stream(first_hops).mapToLong(first_hops_conv_16 -> first_hops_conv_16 == null ? 0 : first_hops_conv_16.ptr & ~1).toArray(), Arrays.stream(last_hops).mapToLong(last_hops_conv_11 -> last_hops_conv_11 == null ? 0 : last_hops_conv_11.ptr & ~1).toArray(), final_value_msat, final_cltv, logger == null ? 0 : logger.ptr);
208 if (ret < 1024) { return null; }
209 Result_RouteLightningErrorZ ret_hu_conv = Result_RouteLightningErrorZ.constr_from_ptr(ret);
210 ret_hu_conv.ptrs_to.add(network);
211 /* TODO 2 ChannelDetails */;
212 /* TODO 2 RouteHint */;
213 ret_hu_conv.ptrs_to.add(logger);
218 * Gets a route from us (payer) to the given target node (payee).
220 * If the payee provided features in their invoice, they should be provided via payee_features.
221 * Without this, MPP will only be used if the payee's features are available in the network graph.
223 * Private routing paths between a public node and the target may be included in `last_hops`.
224 * Currently, only the last hop in each path is considered.
226 * If some channels aren't announced, it may be useful to fill in a first_hops with the
227 * results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
228 * view of our local channels (from net_graph_msg_handler) will be ignored, and only those
229 * in first_hops will be used.
231 * Panics if first_hops contains channels without short_channel_ids
232 * (ChannelManager::list_usable_channels will never include such channels).
234 * The fees on channels from us to next-hops are ignored (as they are assumed to all be
235 * equal), however the enabled/disabled bit on such channels as well as the
236 * htlc_minimum_msat/htlc_maximum_msat *are* checked as they may change based on the receiving node.
238 * Note that payee_features (or a relevant inner pointer) may be NULL or all-0s to represent None
239 * Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None
241 public static Result_RouteLightningErrorZ get_route(byte[] our_node_id, NetworkGraph network, byte[] payee, @Nullable InvoiceFeatures payee_features, ChannelDetails[] first_hops, RouteHint[] last_hops, long final_value_msat, int final_cltv, Logger logger) {
242 long ret = bindings.get_route(our_node_id, network == null ? 0 : network.ptr & ~1, payee, payee_features == null ? 0 : payee_features.ptr & ~1, Arrays.stream(first_hops).mapToLong(first_hops_conv_16 -> first_hops_conv_16 == null ? 0 : first_hops_conv_16.ptr & ~1).toArray(), Arrays.stream(last_hops).mapToLong(last_hops_conv_11 -> last_hops_conv_11 == null ? 0 : last_hops_conv_11.ptr & ~1).toArray(), final_value_msat, final_cltv, logger == null ? 0 : logger.ptr);
243 if (ret < 1024) { return null; }
244 Result_RouteLightningErrorZ ret_hu_conv = Result_RouteLightningErrorZ.constr_from_ptr(ret);
245 ret_hu_conv.ptrs_to.add(network);
246 ret_hu_conv.ptrs_to.add(payee_features);
247 /* TODO 2 ChannelDetails */;
248 /* TODO 2 RouteHint */;
249 ret_hu_conv.ptrs_to.add(logger);
254 * Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
255 * initialization, within a file called \"manager\".
257 public static Result_NoneErrorZ FilesystemPersister_persist_manager(String data_dir, ChannelManager manager) {
258 long ret = bindings.FilesystemPersister_persist_manager(data_dir, manager == null ? 0 : manager.ptr & ~1);
259 if (ret < 1024) { return null; }
260 Result_NoneErrorZ ret_hu_conv = Result_NoneErrorZ.constr_from_ptr(ret);
261 ret_hu_conv.ptrs_to.add(manager);
266 * Utility to construct an invoice. Generally, unless you want to do something like a custom
267 * cltv_expiry, this is what you should be using to create an invoice. The reason being, this
268 * method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
269 * doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
270 * that the payment secret is valid when the invoice is paid.
272 public static Result_InvoiceSignOrCreationErrorZ create_invoice_from_channelmanager(ChannelManager channelmanager, KeysInterface keys_manager, Currency network, Option_u64Z amt_msat, String description) {
273 long ret = bindings.create_invoice_from_channelmanager(channelmanager == null ? 0 : channelmanager.ptr & ~1, keys_manager == null ? 0 : keys_manager.ptr, network, amt_msat.ptr, description);
274 if (ret < 1024) { return null; }
275 Result_InvoiceSignOrCreationErrorZ ret_hu_conv = Result_InvoiceSignOrCreationErrorZ.constr_from_ptr(ret);
276 ret_hu_conv.ptrs_to.add(channelmanager);
277 ret_hu_conv.ptrs_to.add(keys_manager);