java.lang.Object
- org.ldk.structs.HTLCDescriptor

```
public class HTLCDescriptor
extends Object
```
A descriptor used to sign for a commitment transaction's HTLC output.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`HTLCDescriptor`	`clone()`	Creates a copy of the HTLCDescriptor
`WriteableEcdsaChannelSigner`	`derive_channel_signer(SignerProvider signer_provider)`	Derives the channel signer required to sign the HTLC input.
`boolean`	`eq(HTLCDescriptor b)`	Checks if two HTLCDescriptors contain equal inner contents.
`boolean`	`equals(Object o)`
`protected void`	`finalize()`
`ChannelDerivationParameters`	`get_channel_derivation_parameters()`	The parameters required to derive the signer for the HTLC input.
`byte[]`	`get_counterparty_sig()`	The counterparty's signature required to spend the HTLC output.
`HTLCOutputInCommitment`	`get_htlc()`	The details of the HTLC as it appears in the commitment transaction.
`long`	`get_per_commitment_number()`	The number of the commitment transaction in which the HTLC output lives.
`byte[]`	`get_per_commitment_point()`	The key tweak corresponding to the number of the commitment transaction in which the HTLC output lives.
`Option_ThirtyTwoBytesZ`	`get_preimage()`	The preimage, if `Some`, to claim the HTLC output with.
`OutPoint`	`outpoint()`	Returns the outpoint of the HTLC output in the commitment transaction.
`TxOut`	`previous_utxo()`	Returns the UTXO to be spent by the HTLC input, which can be obtained via [`Self::unsigned_tx_input`].
`static Result_HTLCDescriptorDecodeErrorZ`	`read(byte[] ser)`	Read a HTLCDescriptor from a byte array, created by HTLCDescriptor_write
`void`	`set_channel_derivation_parameters(ChannelDerivationParameters val)`	The parameters required to derive the signer for the HTLC input.
`void`	`set_counterparty_sig(byte[] val)`	The counterparty's signature required to spend the HTLC output.
`void`	`set_htlc(HTLCOutputInCommitment val)`	The details of the HTLC as it appears in the commitment transaction.
`void`	`set_per_commitment_number(long val)`	The number of the commitment transaction in which the HTLC output lives.
`void`	`set_per_commitment_point(byte[] val)`	The key tweak corresponding to the number of the commitment transaction in which the HTLC output lives.
`void`	`set_preimage(Option_ThirtyTwoBytesZ val)`	The preimage, if `Some`, to claim the HTLC output with.
`byte[]`	`tx_input_witness(byte[] signature, byte[] witness_script)`	Returns the fully signed witness required to spend the HTLC output in the commitment transaction.
`TxOut`	`tx_output()`	Returns the delayed output created as a result of spending the HTLC output in the commitment transaction.
`TxIn`	`unsigned_tx_input()`	Returns the unsigned transaction input spending the HTLC output in the commitment transaction.
`byte[]`	`witness_script()`	Returns the witness script of the HTLC output in the commitment transaction.
`byte[]`	`write()`	Serialize the HTLCDescriptor object into a byte array which can be read by HTLCDescriptor_read

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - get_channel_derivation_parameters
```
public ChannelDerivationParameters get_channel_derivation_parameters()
```
    The parameters required to derive the signer for the HTLC input.
  - set_channel_derivation_parameters
```
public void set_channel_derivation_parameters(ChannelDerivationParameters val)
```
    The parameters required to derive the signer for the HTLC input.
  - get_per_commitment_number
```
public long get_per_commitment_number()
```
    The number of the commitment transaction in which the HTLC output lives.
  - set_per_commitment_number
```
public void set_per_commitment_number(long val)
```
    The number of the commitment transaction in which the HTLC output lives.
  - get_per_commitment_point
```
public byte[] get_per_commitment_point()
```
    The key tweak corresponding to the number of the commitment transaction in which the HTLC output lives. This tweak is applied to all the basepoints for both parties in the channel to arrive at unique keys per commitment. See for more info.
  - set_per_commitment_point
```
public void set_per_commitment_point(byte[] val)
```
    The key tweak corresponding to the number of the commitment transaction in which the HTLC output lives. This tweak is applied to all the basepoints for both parties in the channel to arrive at unique keys per commitment. See for more info.
  - get_htlc
```
public HTLCOutputInCommitment get_htlc()
```
    The details of the HTLC as it appears in the commitment transaction.
  - set_htlc
```
public void set_htlc(HTLCOutputInCommitment val)
```
    The details of the HTLC as it appears in the commitment transaction.
  - get_preimage
```
public Option_ThirtyTwoBytesZ get_preimage()
```
    The preimage, if `Some`, to claim the HTLC output with. If `None`, the timeout path must be taken.
  - set_preimage
```
public void set_preimage(Option_ThirtyTwoBytesZ val)
```
    The preimage, if `Some`, to claim the HTLC output with. If `None`, the timeout path must be taken.
  - get_counterparty_sig
```
public byte[] get_counterparty_sig()
```
    The counterparty's signature required to spend the HTLC output.
  - set_counterparty_sig
```
public void set_counterparty_sig(byte[] val)
```
    The counterparty's signature required to spend the HTLC output.
  - clone
```
public HTLCDescriptor clone()
```
    Creates a copy of the HTLCDescriptor
    
    Overrides:
    
    clone in class Object
  - eq
```
public boolean eq(HTLCDescriptor b)
```
    Checks if two HTLCDescriptors contain equal inner contents. This ignores pointers and is_owned flags and looks at the values in fields. Two objects with NULL inner values will be considered "equal" here.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - write
```
public byte[] write()
```
    Serialize the HTLCDescriptor object into a byte array which can be read by HTLCDescriptor_read
  - read
```
public static Result_HTLCDescriptorDecodeErrorZ read(byte[] ser)
```
    Read a HTLCDescriptor from a byte array, created by HTLCDescriptor_write
  - outpoint
```
public OutPoint outpoint()
```
    Returns the outpoint of the HTLC output in the commitment transaction. This is the outpoint being spent by the HTLC input in the HTLC transaction.
  - previous_utxo
```
public TxOut previous_utxo()
```
    Returns the UTXO to be spent by the HTLC input, which can be obtained via [`Self::unsigned_tx_input`].
  - unsigned_tx_input
```
public TxIn unsigned_tx_input()
```
    Returns the unsigned transaction input spending the HTLC output in the commitment transaction.
  - tx_output
```
public TxOut tx_output()
```
    Returns the delayed output created as a result of spending the HTLC output in the commitment transaction.
  - witness_script
```
public byte[] witness_script()
```
    Returns the witness script of the HTLC output in the commitment transaction.
  - tx_input_witness
```
public byte[] tx_input_witness(byte[] signature,
                               byte[] witness_script)
```
    Returns the fully signed witness required to spend the HTLC output in the commitment transaction.
  - derive_channel_signer
```
public WriteableEcdsaChannelSigner derive_channel_signer(SignerProvider signer_provider)
```
    Derives the channel signer required to sign the HTLC input.

Class HTLCDescriptor

Method Summary

Methods inherited from class java.lang.Object

Method Detail

finalize

get_channel_derivation_parameters

set_channel_derivation_parameters

get_per_commitment_number

set_per_commitment_number

get_per_commitment_point

set_per_commitment_point

get_htlc

set_htlc

get_preimage

set_preimage

get_counterparty_sig

set_counterparty_sig

clone

eq

equals

write

read

outpoint

previous_utxo

unsigned_tx_input

tx_output

witness_script

tx_input_witness

derive_channel_signer