org.ldk.structs.SpendableOutputDescriptor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ldk-java Show documentation
Show all versions of ldk-java Show documentation
LDK Java Bindings and Release Binaries
package org.ldk.structs;
import org.ldk.impl.bindings;
import org.ldk.enums.*;
import org.ldk.util.*;
import java.util.Arrays;
import java.lang.ref.Reference;
import javax.annotation.Nullable;
/**
* Describes the necessary information to spend a spendable output.
*
* When on-chain outputs are created by LDK (which our counterparty is not able to claim at any
* point in the future) a [`SpendableOutputs`] event is generated which you must track and be able
* to spend on-chain. The information needed to do this is provided in this enum, including the
* outpoint describing which `txid` and output `index` is available, the full output which exists
* at that `txid`/`index`, and any keys or other information required to sign.
*
* [`SpendableOutputs`]: crate::events::Event::SpendableOutputs
*/
@SuppressWarnings("unchecked") // We correctly assign various generic arrays
public class SpendableOutputDescriptor extends CommonBase {
private SpendableOutputDescriptor(Object _dummy, long ptr) { super(ptr); }
@Override @SuppressWarnings("deprecation")
protected void finalize() throws Throwable {
super.finalize();
if (ptr != 0) { bindings.SpendableOutputDescriptor_free(ptr); }
}
static SpendableOutputDescriptor constr_from_ptr(long ptr) {
bindings.LDKSpendableOutputDescriptor raw_val = bindings.LDKSpendableOutputDescriptor_ref_from_ptr(ptr);
if (raw_val.getClass() == bindings.LDKSpendableOutputDescriptor.StaticOutput.class) {
return new StaticOutput(ptr, (bindings.LDKSpendableOutputDescriptor.StaticOutput)raw_val);
}
if (raw_val.getClass() == bindings.LDKSpendableOutputDescriptor.DelayedPaymentOutput.class) {
return new DelayedPaymentOutput(ptr, (bindings.LDKSpendableOutputDescriptor.DelayedPaymentOutput)raw_val);
}
if (raw_val.getClass() == bindings.LDKSpendableOutputDescriptor.StaticPaymentOutput.class) {
return new StaticPaymentOutput(ptr, (bindings.LDKSpendableOutputDescriptor.StaticPaymentOutput)raw_val);
}
assert false; return null; // Unreachable without extending the (internal) bindings interface
}
/**
* An output to a script which was provided via [`SignerProvider`] directly, either from
* [`get_destination_script`] or [`get_shutdown_scriptpubkey`], thus you should already
* know how to spend it. No secret keys are provided as LDK was never given any key.
* These may include outputs from a transaction punishing our counterparty or claiming an HTLC
* on-chain using the payment preimage or after it has timed out.
*
* [`get_shutdown_scriptpubkey`]: SignerProvider::get_shutdown_scriptpubkey
* [`get_destination_script`]: SignerProvider::get_shutdown_scriptpubkey
*/
public final static class StaticOutput extends SpendableOutputDescriptor {
/**
* The outpoint which is spendable.
*/
public final org.ldk.structs.OutPoint outpoint;
/**
* The output which is referenced by the given outpoint.
*/
public final org.ldk.structs.TxOut output;
private StaticOutput(long ptr, bindings.LDKSpendableOutputDescriptor.StaticOutput obj) {
super(null, ptr);
long outpoint = obj.outpoint;
org.ldk.structs.OutPoint outpoint_hu_conv = null; if (outpoint < 0 || outpoint > 4096) { outpoint_hu_conv = new org.ldk.structs.OutPoint(null, outpoint); }
if (outpoint_hu_conv != null) { outpoint_hu_conv.ptrs_to.add(this); };
this.outpoint = outpoint_hu_conv;
long output = obj.output;
TxOut output_conv = new TxOut(null, output);
this.output = output_conv;
}
}
/**
* An output to a P2WSH script which can be spent with a single signature after an `OP_CSV`
* delay.
*
* The witness in the spending input should be:
* ```bitcoin
* (MINIMALIF standard rule)
* ```
*
* Note that the `nSequence` field in the spending input must be set to
* [`DelayedPaymentOutputDescriptor::to_self_delay`] (which means the transaction is not
* broadcastable until at least [`DelayedPaymentOutputDescriptor::to_self_delay`] blocks after
* the outpoint confirms, see [BIP
* 68](https://github.com/bitcoin/bips/blob/master/bip-0068.mediawiki)). Also note that LDK
* won't generate a [`SpendableOutputDescriptor`] until the corresponding block height
* is reached.
*
* These are generally the result of a \"revocable\" output to us, spendable only by us unless
* it is an output from an old state which we broadcast (which should never happen).
*
* To derive the delayed payment key which is used to sign this input, you must pass the
* holder [`InMemorySigner::delayed_payment_base_key`] (i.e., the private key which corresponds to the
* [`ChannelPublicKeys::delayed_payment_basepoint`] in [`ChannelSigner::pubkeys`]) and the provided
* [`DelayedPaymentOutputDescriptor::per_commitment_point`] to [`chan_utils::derive_private_key`]. The public key can be
* generated without the secret key using [`chan_utils::derive_public_key`] and only the
* [`ChannelPublicKeys::delayed_payment_basepoint`] which appears in [`ChannelSigner::pubkeys`].
*
* To derive the [`DelayedPaymentOutputDescriptor::revocation_pubkey`] provided here (which is
* used in the witness script generation), you must pass the counterparty
* [`ChannelPublicKeys::revocation_basepoint`] (which appears in the call to
* [`ChannelSigner::provide_channel_parameters`]) and the provided
* [`DelayedPaymentOutputDescriptor::per_commitment_point`] to
* [`chan_utils::derive_public_revocation_key`].
*
* The witness script which is hashed and included in the output `script_pubkey` may be
* regenerated by passing the [`DelayedPaymentOutputDescriptor::revocation_pubkey`] (derived
* as explained above), our delayed payment pubkey (derived as explained above), and the
* [`DelayedPaymentOutputDescriptor::to_self_delay`] contained here to
* [`chan_utils::get_revokeable_redeemscript`].
*/
public final static class DelayedPaymentOutput extends SpendableOutputDescriptor {
public final org.ldk.structs.DelayedPaymentOutputDescriptor delayed_payment_output;
private DelayedPaymentOutput(long ptr, bindings.LDKSpendableOutputDescriptor.DelayedPaymentOutput obj) {
super(null, ptr);
long delayed_payment_output = obj.delayed_payment_output;
org.ldk.structs.DelayedPaymentOutputDescriptor delayed_payment_output_hu_conv = null; if (delayed_payment_output < 0 || delayed_payment_output > 4096) { delayed_payment_output_hu_conv = new org.ldk.structs.DelayedPaymentOutputDescriptor(null, delayed_payment_output); }
if (delayed_payment_output_hu_conv != null) { delayed_payment_output_hu_conv.ptrs_to.add(this); };
this.delayed_payment_output = delayed_payment_output_hu_conv;
}
}
/**
* An output spendable exclusively by our payment key (i.e., the private key that corresponds
* to the `payment_point` in [`ChannelSigner::pubkeys`]). The output type depends on the
* channel type negotiated.
*
* On an anchor outputs channel, the witness in the spending input is:
* ```bitcoin
*
* ```
*
* Otherwise, it is:
* ```bitcoin
*
* ```
*
* These are generally the result of our counterparty having broadcast the current state,
* allowing us to claim the non-HTLC-encumbered outputs immediately, or after one confirmation
* in the case of anchor outputs channels.
*/
public final static class StaticPaymentOutput extends SpendableOutputDescriptor {
public final org.ldk.structs.StaticPaymentOutputDescriptor static_payment_output;
private StaticPaymentOutput(long ptr, bindings.LDKSpendableOutputDescriptor.StaticPaymentOutput obj) {
super(null, ptr);
long static_payment_output = obj.static_payment_output;
org.ldk.structs.StaticPaymentOutputDescriptor static_payment_output_hu_conv = null; if (static_payment_output < 0 || static_payment_output > 4096) { static_payment_output_hu_conv = new org.ldk.structs.StaticPaymentOutputDescriptor(null, static_payment_output); }
if (static_payment_output_hu_conv != null) { static_payment_output_hu_conv.ptrs_to.add(this); };
this.static_payment_output = static_payment_output_hu_conv;
}
}
long clone_ptr() {
long ret = bindings.SpendableOutputDescriptor_clone_ptr(this.ptr);
Reference.reachabilityFence(this);
return ret;
}
/**
* Creates a copy of the SpendableOutputDescriptor
*/
public SpendableOutputDescriptor clone() {
long ret = bindings.SpendableOutputDescriptor_clone(this.ptr);
Reference.reachabilityFence(this);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.SpendableOutputDescriptor ret_hu_conv = org.ldk.structs.SpendableOutputDescriptor.constr_from_ptr(ret);
if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
return ret_hu_conv;
}
/**
* Utility method to constructs a new StaticOutput-variant SpendableOutputDescriptor
*/
public static SpendableOutputDescriptor static_output(org.ldk.structs.OutPoint outpoint, org.ldk.structs.TxOut output) {
long ret = bindings.SpendableOutputDescriptor_static_output(outpoint == null ? 0 : outpoint.ptr, output.ptr);
Reference.reachabilityFence(outpoint);
Reference.reachabilityFence(output);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.SpendableOutputDescriptor ret_hu_conv = org.ldk.structs.SpendableOutputDescriptor.constr_from_ptr(ret);
if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(outpoint); };
return ret_hu_conv;
}
/**
* Utility method to constructs a new DelayedPaymentOutput-variant SpendableOutputDescriptor
*/
public static SpendableOutputDescriptor delayed_payment_output(org.ldk.structs.DelayedPaymentOutputDescriptor a) {
long ret = bindings.SpendableOutputDescriptor_delayed_payment_output(a == null ? 0 : a.ptr);
Reference.reachabilityFence(a);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.SpendableOutputDescriptor ret_hu_conv = org.ldk.structs.SpendableOutputDescriptor.constr_from_ptr(ret);
if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(a); };
return ret_hu_conv;
}
/**
* Utility method to constructs a new StaticPaymentOutput-variant SpendableOutputDescriptor
*/
public static SpendableOutputDescriptor static_payment_output(org.ldk.structs.StaticPaymentOutputDescriptor a) {
long ret = bindings.SpendableOutputDescriptor_static_payment_output(a == null ? 0 : a.ptr);
Reference.reachabilityFence(a);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.SpendableOutputDescriptor ret_hu_conv = org.ldk.structs.SpendableOutputDescriptor.constr_from_ptr(ret);
if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(a); };
return ret_hu_conv;
}
/**
* Generates a non-cryptographic 64-bit hash of the SpendableOutputDescriptor.
*/
public long hash() {
long ret = bindings.SpendableOutputDescriptor_hash(this.ptr);
Reference.reachabilityFence(this);
return ret;
}
@Override public int hashCode() {
return (int)this.hash();
}
/**
* Checks if two SpendableOutputDescriptors contain equal inner contents.
* This ignores pointers and is_owned flags and looks at the values in fields.
*/
public boolean eq(org.ldk.structs.SpendableOutputDescriptor b) {
boolean ret = bindings.SpendableOutputDescriptor_eq(this.ptr, b == null ? 0 : b.ptr);
Reference.reachabilityFence(this);
Reference.reachabilityFence(b);
return ret;
}
@Override public boolean equals(Object o) {
if (!(o instanceof SpendableOutputDescriptor)) return false;
return this.eq((SpendableOutputDescriptor)o);
}
/**
* Serialize the SpendableOutputDescriptor object into a byte array which can be read by SpendableOutputDescriptor_read
*/
public byte[] write() {
byte[] ret = bindings.SpendableOutputDescriptor_write(this.ptr);
Reference.reachabilityFence(this);
return ret;
}
/**
* Read a SpendableOutputDescriptor from a byte array, created by SpendableOutputDescriptor_write
*/
public static Result_SpendableOutputDescriptorDecodeErrorZ read(byte[] ser) {
long ret = bindings.SpendableOutputDescriptor_read(ser);
Reference.reachabilityFence(ser);
if (ret >= 0 && ret <= 4096) { return null; }
Result_SpendableOutputDescriptorDecodeErrorZ ret_hu_conv = Result_SpendableOutputDescriptorDecodeErrorZ.constr_from_ptr(ret);
return ret_hu_conv;
}
}