import org.ldk.enums.*;
import org.ldk.util.*;
import java.util.Arrays;
+import java.lang.ref.Reference;
import javax.annotation.Nullable;
/**
public static interface KeysInterfaceInterface {
/**
- * Get node secret key (aka node_id or network_key).
+ * Get node secret key based on the provided [`Recipient`].
*
- * This method must return the same value each time it is called.
+ * The `node_id`/`network_key` is the public key that corresponds to this secret key.
+ *
+ * This method must return the same value each time it is called with a given [`Recipient`]
+ * parameter.
+ *
+ * Errors if the [`Recipient`] variant is not supported by the implementation.
+ */
+ Result_SecretKeyNoneZ get_node_secret(Recipient recipient);
+ /**
+ * Get node id based on the provided [`Recipient`]. This public key corresponds to the secret in
+ * [`get_node_secret`].
+ *
+ * This method must return the same value each time it is called with a given [`Recipient`]
+ * parameter.
+ *
+ * Errors if the [`Recipient`] variant is not supported by the implementation.
+ *
+ * [`get_node_secret`]: Self::get_node_secret
*/
- byte[] get_node_secret();
+ Result_PublicKeyNoneZ get_node_id(Recipient recipient);
+ /**
+ * Gets the ECDH shared secret of our [`node secret`] and `other_key`, multiplying by `tweak` if
+ * one is provided. Note that this tweak can be applied to `other_key` instead of our node
+ * secret, though this is less efficient.
+ *
+ * Errors if the [`Recipient`] variant is not supported by the implementation.
+ *
+ * [`node secret`]: Self::get_node_secret
+ */
+ Result_SharedSecretNoneZ ecdh(Recipient recipient, byte[] other_key, Option_ScalarZ tweak);
/**
* Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
*
*/
ShutdownScript get_shutdown_scriptpubkey();
/**
- * Get a new set of Sign for per-channel secrets. These MUST be unique even if you
+ * Get a new set of [`Sign`] for per-channel secrets. These MUST be unique even if you
* restarted with some stale data!
*
* This method must return a different value each time it is called.
*/
- Sign get_channel_signer(boolean inbound, long channel_value_satoshis);
+ byte[] generate_channel_keys_id(boolean inbound, long channel_value_satoshis, UInt128 user_channel_id);
+ /**
+ * Derives the private key material backing a `Signer`.
+ *
+ * To derive a new `Signer`, a fresh `channel_keys_id` should be obtained through
+ * [`KeysInterface::generate_channel_keys_id`]. Otherwise, an existing `Signer` can be
+ * re-derived from its `channel_keys_id`, which can be obtained through its trait method
+ * [`BaseSign::channel_keys_id`].
+ */
+ Sign derive_channel_signer(long channel_value_satoshis, byte[] channel_keys_id);
/**
* Gets a unique, cryptographically-secure, random 32 byte value. This is used for encrypting
* onion packets and for temporary channel IDs. There is no requirement that these be
*/
byte[] get_secure_random_bytes();
/**
- * Reads a `Signer` for this `KeysInterface` from the given input stream.
+ * Reads a [`Signer`] for this [`KeysInterface`] from the given input stream.
* This is only called during deserialization of other objects which contain
- * `Sign`-implementing objects (ie `ChannelMonitor`s and `ChannelManager`s).
+ * [`Sign`]-implementing objects (i.e., [`ChannelMonitor`]s and [`ChannelManager`]s).
* The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
* contain no versioning scheme. You may wish to include your own version prefix and ensure
* you've read all of the provided bytes to ensure no corruption occurred.
+ *
+ * This method is slowly being phased out -- it will only be called when reading objects
+ * written by LDK versions prior to 0.0.113.
+ *
+ * [`Signer`]: Self::Signer
+ * [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
+ * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
*/
Result_SignDecodeErrorZ read_chan_signer(byte[] reader);
/**
- * Sign an invoice's preimage (note that this is the preimage of the invoice, not the HTLC's
- * preimage). By parameterizing by the preimage instead of the hash, we allow implementors of
+ * Sign an invoice.
+ * By parameterizing by the raw invoice bytes instead of the hash, we allow implementors of
* this trait to parse the invoice and make sure they're signing what they expect, rather than
* blindly signing the hash.
+ * The `hrp` is ASCII bytes, while the invoice data is base32-encoded.
+ *
+ * The secret key used to sign the invoice is dependent on the [`Recipient`].
+ *
+ * Errors if the [`Recipient`] variant is not supported by the implementation.
*/
- Result_RecoverableSignatureNoneZ sign_invoice(byte[] invoice_preimage);
+ Result_RecoverableSignatureNoneZ sign_invoice(byte[] hrp_bytes, UInt5[] invoice_data, Recipient receipient);
+ /**
+ * Get secret key material as bytes for use in encrypting and decrypting inbound payment data.
+ *
+ * If the implementor of this trait supports [phantom node payments], then every node that is
+ * intended to be included in the phantom invoice route hints must return the same value from
+ * this method.
+ *
+ * This method must return the same value each time it is called.
+ *
+ * [phantom node payments]: PhantomKeysManager
+ */
+ byte[] get_inbound_payment_key_material();
}
private static class LDKKeysInterfaceHolder { KeysInterface held; }
public static KeysInterface new_impl(KeysInterfaceInterface arg) {
final LDKKeysInterfaceHolder impl_holder = new LDKKeysInterfaceHolder();
impl_holder.held = new KeysInterface(new bindings.LDKKeysInterface() {
- @Override public byte[] get_node_secret() {
- byte[] ret = arg.get_node_secret();
- return ret;
+ @Override public long get_node_secret(Recipient recipient) {
+ Result_SecretKeyNoneZ ret = arg.get_node_secret(recipient);
+ Reference.reachabilityFence(arg);
+ long result = ret == null ? 0 : ret.clone_ptr();
+ return result;
+ }
+ @Override public long get_node_id(Recipient recipient) {
+ Result_PublicKeyNoneZ ret = arg.get_node_id(recipient);
+ Reference.reachabilityFence(arg);
+ long result = ret == null ? 0 : ret.clone_ptr();
+ return result;
+ }
+ @Override public long ecdh(Recipient recipient, byte[] other_key, long tweak) {
+ org.ldk.structs.Option_ScalarZ tweak_hu_conv = org.ldk.structs.Option_ScalarZ.constr_from_ptr(tweak);
+ if (tweak_hu_conv != null) { tweak_hu_conv.ptrs_to.add(this); };
+ Result_SharedSecretNoneZ ret = arg.ecdh(recipient, other_key, tweak_hu_conv);
+ Reference.reachabilityFence(arg);
+ long result = ret == null ? 0 : ret.clone_ptr();
+ return result;
}
@Override public byte[] get_destination_script() {
byte[] ret = arg.get_destination_script();
+ Reference.reachabilityFence(arg);
return ret;
}
@Override public long get_shutdown_scriptpubkey() {
ShutdownScript ret = arg.get_shutdown_scriptpubkey();
- long result = ret == null ? 0 : ret.ptr & ~1;
- impl_holder.held.ptrs_to.add(ret);
+ Reference.reachabilityFence(arg);
+ long result = ret == null ? 0 : ret.clone_ptr();
return result;
}
- @Override public long get_channel_signer(boolean inbound, long channel_value_satoshis) {
- Sign ret = arg.get_channel_signer(inbound, channel_value_satoshis);
- long result = ret == null ? 0 : ret.ptr;
- impl_holder.held.ptrs_to.add(ret);
+ @Override public byte[] generate_channel_keys_id(boolean inbound, long channel_value_satoshis, byte[] user_channel_id) {
+ org.ldk.util.UInt128 user_channel_id_conv = new org.ldk.util.UInt128(user_channel_id);
+ byte[] ret = arg.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id_conv);
+ Reference.reachabilityFence(arg);
+ byte[] result = InternalUtils.check_arr_len(ret, 32);
+ return result;
+ }
+ @Override public long derive_channel_signer(long channel_value_satoshis, byte[] channel_keys_id) {
+ Sign ret = arg.derive_channel_signer(channel_value_satoshis, channel_keys_id);
+ Reference.reachabilityFence(arg);
+ long result = ret == null ? 0 : ret.clone_ptr();
+ if (impl_holder.held != null) { impl_holder.held.ptrs_to.add(ret); };
return result;
}
@Override public byte[] get_secure_random_bytes() {
byte[] ret = arg.get_secure_random_bytes();
- return ret;
+ Reference.reachabilityFence(arg);
+ byte[] result = InternalUtils.check_arr_len(ret, 32);
+ return result;
}
@Override public long read_chan_signer(byte[] reader) {
Result_SignDecodeErrorZ ret = arg.read_chan_signer(reader);
- long result = ret != null ? ret.ptr : 0;
+ Reference.reachabilityFence(arg);
+ long result = ret == null ? 0 : ret.clone_ptr();
+ return result;
+ }
+ @Override public long sign_invoice(byte[] hrp_bytes, byte[] invoice_data, Recipient receipient) {
+ int invoice_data_conv_7_len = invoice_data.length;
+ UInt5[] invoice_data_conv_7_arr = new UInt5[invoice_data_conv_7_len];
+ for (int h = 0; h < invoice_data_conv_7_len; h++) {
+ byte invoice_data_conv_7 = invoice_data[h];
+ UInt5 invoice_data_conv_7_conv = new UInt5(invoice_data_conv_7);
+ invoice_data_conv_7_arr[h] = invoice_data_conv_7_conv;
+ }
+ Result_RecoverableSignatureNoneZ ret = arg.sign_invoice(hrp_bytes, invoice_data_conv_7_arr, receipient);
+ Reference.reachabilityFence(arg);
+ long result = ret == null ? 0 : ret.clone_ptr();
return result;
}
- @Override public long sign_invoice(byte[] invoice_preimage) {
- Result_RecoverableSignatureNoneZ ret = arg.sign_invoice(invoice_preimage);
- long result = ret != null ? ret.ptr : 0;
+ @Override public byte[] get_inbound_payment_key_material() {
+ byte[] ret = arg.get_inbound_payment_key_material();
+ Reference.reachabilityFence(arg);
+ byte[] result = InternalUtils.check_arr_len(ret, 32);
return result;
}
});
return impl_holder.held;
}
/**
- * Get node secret key (aka node_id or network_key).
+ * Get node secret key based on the provided [`Recipient`].
*
- * This method must return the same value each time it is called.
+ * The `node_id`/`network_key` is the public key that corresponds to this secret key.
+ *
+ * This method must return the same value each time it is called with a given [`Recipient`]
+ * parameter.
+ *
+ * Errors if the [`Recipient`] variant is not supported by the implementation.
*/
- public byte[] get_node_secret() {
- byte[] ret = bindings.KeysInterface_get_node_secret(this.ptr);
- return ret;
+ public Result_SecretKeyNoneZ get_node_secret(org.ldk.enums.Recipient recipient) {
+ long ret = bindings.KeysInterface_get_node_secret(this.ptr, recipient);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(recipient);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ Result_SecretKeyNoneZ ret_hu_conv = Result_SecretKeyNoneZ.constr_from_ptr(ret);
+ return ret_hu_conv;
+ }
+
+ /**
+ * Get node id based on the provided [`Recipient`]. This public key corresponds to the secret in
+ * [`get_node_secret`].
+ *
+ * This method must return the same value each time it is called with a given [`Recipient`]
+ * parameter.
+ *
+ * Errors if the [`Recipient`] variant is not supported by the implementation.
+ *
+ * [`get_node_secret`]: Self::get_node_secret
+ */
+ public Result_PublicKeyNoneZ get_node_id(org.ldk.enums.Recipient recipient) {
+ long ret = bindings.KeysInterface_get_node_id(this.ptr, recipient);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(recipient);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ Result_PublicKeyNoneZ ret_hu_conv = Result_PublicKeyNoneZ.constr_from_ptr(ret);
+ return ret_hu_conv;
+ }
+
+ /**
+ * Gets the ECDH shared secret of our [`node secret`] and `other_key`, multiplying by `tweak` if
+ * one is provided. Note that this tweak can be applied to `other_key` instead of our node
+ * secret, though this is less efficient.
+ *
+ * Errors if the [`Recipient`] variant is not supported by the implementation.
+ *
+ * [`node secret`]: Self::get_node_secret
+ */
+ public Result_SharedSecretNoneZ ecdh(org.ldk.enums.Recipient recipient, byte[] other_key, org.ldk.structs.Option_ScalarZ tweak) {
+ long ret = bindings.KeysInterface_ecdh(this.ptr, recipient, InternalUtils.check_arr_len(other_key, 33), tweak.ptr);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(recipient);
+ Reference.reachabilityFence(other_key);
+ Reference.reachabilityFence(tweak);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ Result_SharedSecretNoneZ ret_hu_conv = Result_SharedSecretNoneZ.constr_from_ptr(ret);
+ return ret_hu_conv;
}
/**
*/
public byte[] get_destination_script() {
byte[] ret = bindings.KeysInterface_get_destination_script(this.ptr);
+ Reference.reachabilityFence(this);
return ret;
}
*/
public ShutdownScript get_shutdown_scriptpubkey() {
long ret = bindings.KeysInterface_get_shutdown_scriptpubkey(this.ptr);
- if (ret < 1024) { return null; }
- ShutdownScript ret_hu_conv = new ShutdownScript(null, ret);
- ret_hu_conv.ptrs_to.add(this);
+ Reference.reachabilityFence(this);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.ShutdownScript ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ShutdownScript(null, ret); }
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
return ret_hu_conv;
}
/**
- * Get a new set of Sign for per-channel secrets. These MUST be unique even if you
+ * Get a new set of [`Sign`] for per-channel secrets. These MUST be unique even if you
* restarted with some stale data!
*
* This method must return a different value each time it is called.
*/
- public Sign get_channel_signer(boolean inbound, long channel_value_satoshis) {
- long ret = bindings.KeysInterface_get_channel_signer(this.ptr, inbound, channel_value_satoshis);
- if (ret < 1024) { return null; }
+ public byte[] generate_channel_keys_id(boolean inbound, long channel_value_satoshis, org.ldk.util.UInt128 user_channel_id) {
+ byte[] ret = bindings.KeysInterface_generate_channel_keys_id(this.ptr, inbound, channel_value_satoshis, user_channel_id.getLEBytes());
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(inbound);
+ Reference.reachabilityFence(channel_value_satoshis);
+ Reference.reachabilityFence(user_channel_id);
+ return ret;
+ }
+
+ /**
+ * Derives the private key material backing a `Signer`.
+ *
+ * To derive a new `Signer`, a fresh `channel_keys_id` should be obtained through
+ * [`KeysInterface::generate_channel_keys_id`]. Otherwise, an existing `Signer` can be
+ * re-derived from its `channel_keys_id`, which can be obtained through its trait method
+ * [`BaseSign::channel_keys_id`].
+ */
+ public Sign derive_channel_signer(long channel_value_satoshis, byte[] channel_keys_id) {
+ long ret = bindings.KeysInterface_derive_channel_signer(this.ptr, channel_value_satoshis, InternalUtils.check_arr_len(channel_keys_id, 32));
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(channel_value_satoshis);
+ Reference.reachabilityFence(channel_keys_id);
+ if (ret >= 0 && ret <= 4096) { return null; }
Sign ret_hu_conv = new Sign(null, ret);
- ret_hu_conv.ptrs_to.add(this);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
return ret_hu_conv;
}
*/
public byte[] get_secure_random_bytes() {
byte[] ret = bindings.KeysInterface_get_secure_random_bytes(this.ptr);
+ Reference.reachabilityFence(this);
return ret;
}
/**
- * Reads a `Signer` for this `KeysInterface` from the given input stream.
+ * Reads a [`Signer`] for this [`KeysInterface`] from the given input stream.
* This is only called during deserialization of other objects which contain
- * `Sign`-implementing objects (ie `ChannelMonitor`s and `ChannelManager`s).
+ * [`Sign`]-implementing objects (i.e., [`ChannelMonitor`]s and [`ChannelManager`]s).
* The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
* contain no versioning scheme. You may wish to include your own version prefix and ensure
* you've read all of the provided bytes to ensure no corruption occurred.
+ *
+ * This method is slowly being phased out -- it will only be called when reading objects
+ * written by LDK versions prior to 0.0.113.
+ *
+ * [`Signer`]: Self::Signer
+ * [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
+ * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
*/
public Result_SignDecodeErrorZ read_chan_signer(byte[] reader) {
long ret = bindings.KeysInterface_read_chan_signer(this.ptr, reader);
- if (ret < 1024) { return null; }
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(reader);
+ if (ret >= 0 && ret <= 4096) { return null; }
Result_SignDecodeErrorZ ret_hu_conv = Result_SignDecodeErrorZ.constr_from_ptr(ret);
return ret_hu_conv;
}
/**
- * Sign an invoice's preimage (note that this is the preimage of the invoice, not the HTLC's
- * preimage). By parameterizing by the preimage instead of the hash, we allow implementors of
+ * Sign an invoice.
+ * By parameterizing by the raw invoice bytes instead of the hash, we allow implementors of
* this trait to parse the invoice and make sure they're signing what they expect, rather than
* blindly signing the hash.
+ * The `hrp` is ASCII bytes, while the invoice data is base32-encoded.
+ *
+ * The secret key used to sign the invoice is dependent on the [`Recipient`].
+ *
+ * Errors if the [`Recipient`] variant is not supported by the implementation.
*/
- public Result_RecoverableSignatureNoneZ sign_invoice(byte[] invoice_preimage) {
- long ret = bindings.KeysInterface_sign_invoice(this.ptr, invoice_preimage);
- if (ret < 1024) { return null; }
+ public Result_RecoverableSignatureNoneZ sign_invoice(byte[] hrp_bytes, UInt5[] invoice_data, org.ldk.enums.Recipient receipient) {
+ long ret = bindings.KeysInterface_sign_invoice(this.ptr, hrp_bytes, invoice_data != null ? InternalUtils.convUInt5Array(invoice_data) : null, receipient);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(hrp_bytes);
+ Reference.reachabilityFence(invoice_data);
+ Reference.reachabilityFence(receipient);
+ if (ret >= 0 && ret <= 4096) { return null; }
Result_RecoverableSignatureNoneZ ret_hu_conv = Result_RecoverableSignatureNoneZ.constr_from_ptr(ret);
return ret_hu_conv;
}
+ /**
+ * Get secret key material as bytes for use in encrypting and decrypting inbound payment data.
+ *
+ * If the implementor of this trait supports [phantom node payments], then every node that is
+ * intended to be included in the phantom invoice route hints must return the same value from
+ * this method.
+ *
+ * This method must return the same value each time it is called.
+ *
+ * [phantom node payments]: PhantomKeysManager
+ */
+ public byte[] get_inbound_payment_key_material() {
+ byte[] ret = bindings.KeysInterface_get_inbound_payment_key_material(this.ptr);
+ Reference.reachabilityFence(this);
+ return ret;
+ }
+
}
projects / ldk-java / blobdiff