Direct Known Subclasses:

Event.BumpTransaction, Event.ChannelClosed, Event.ChannelPending, Event.ChannelReady, Event.DiscardFunding, Event.FundingGenerationReady, Event.HTLCHandlingFailed, Event.HTLCIntercepted, Event.OpenChannelRequest, Event.PaymentClaimable, Event.PaymentClaimed, Event.PaymentFailed, Event.PaymentForwarded, Event.PaymentPathFailed, Event.PaymentPathSuccessful, Event.PaymentSent, Event.PendingHTLCsForwardable, Event.ProbeFailed, Event.ProbeSuccessful, Event.SpendableOutputs
```
public class Event
extends Object
```
An Event which you should probably take some action in response to. Note that while Writeable and Readable are implemented for Event, you probably shouldn't use them directly as they don't round-trip exactly (for example FundingGenerationReady is never written as it makes no sense to respond to it after reconnecting to peers).

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Event.BumpTransaction`	Indicates that a transaction originating from LDK needs to have its fee bumped.
`static class`	`Event.ChannelClosed`	Used to indicate that a previously opened channel with the given `channel_id` is in the process of closure.
`static class`	`Event.ChannelPending`	Used to indicate that a channel with the given `channel_id` is being opened and pending confirmation on-chain.
`static class`	`Event.ChannelReady`	Used to indicate that a channel with the given `channel_id` is ready to be used.
`static class`	`Event.DiscardFunding`	Used to indicate to the user that they can abandon the funding transaction and recycle the inputs for another purpose.
`static class`	`Event.FundingGenerationReady`	Used to indicate that the client should generate a funding transaction with the given parameters and then call [`ChannelManager::funding_transaction_generated`].
`static class`	`Event.HTLCHandlingFailed`	Indicates that the HTLC was accepted, but could not be processed when or after attempting to forward it.
`static class`	`Event.HTLCIntercepted`	Used to indicate that we've intercepted an HTLC forward.
`static class`	`Event.OpenChannelRequest`	Indicates a request to open a new channel by a peer.
`static class`	`Event.PaymentClaimable`	Indicates that we've been offered a payment and it needs to be claimed via calling [`ChannelManager::claim_funds`] with the preimage given in [`PaymentPurpose`].
`static class`	`Event.PaymentClaimed`	Indicates a payment has been claimed and we've received money! This most likely occurs when [`ChannelManager::claim_funds`] has been called in response to an [`Event::PaymentClaimable`].
`static class`	`Event.PaymentFailed`	Indicates an outbound payment failed.
`static class`	`Event.PaymentForwarded`	This event is generated when a payment has been successfully forwarded through us and a forwarding fee earned.
`static class`	`Event.PaymentPathFailed`	Indicates an outbound HTLC we sent failed, likely due to an intermediary node being unable to handle the HTLC.
`static class`	`Event.PaymentPathSuccessful`	Indicates that a path for an outbound payment was successful.
`static class`	`Event.PaymentSent`	Indicates an outbound payment we made succeeded (i.e.
`static class`	`Event.PendingHTLCsForwardable`	Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at a time in the future.
`static class`	`Event.ProbeFailed`	Indicates that a probe payment we sent failed at an intermediary node on the path.
`static class`	`Event.ProbeSuccessful`	Indicates that a probe payment we sent returned successful, i.e., only failed at the destination.
`static class`	`Event.SpendableOutputs`	Used to indicate that an output which you should know how to spend was confirmed on chain and is now spendable.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Event`	`bump_transaction(BumpTransactionEvent a)`	Utility method to constructs a new BumpTransaction-variant Event
`static Event`	`channel_closed(byte[] channel_id, UInt128 user_channel_id, ClosureReason reason, byte[] counterparty_node_id, Option_u64Z channel_capacity_sats)`	Utility method to constructs a new ChannelClosed-variant Event
`static Event`	`channel_pending(byte[] channel_id, UInt128 user_channel_id, Option_ThirtyTwoBytesZ former_temporary_channel_id, byte[] counterparty_node_id, OutPoint funding_txo)`	Utility method to constructs a new ChannelPending-variant Event
`static Event`	`channel_ready(byte[] channel_id, UInt128 user_channel_id, byte[] counterparty_node_id, ChannelTypeFeatures channel_type)`	Utility method to constructs a new ChannelReady-variant Event
`Event`	`clone()`	Creates a copy of the Event
`static Event`	`discard_funding(byte[] channel_id, byte[] transaction)`	Utility method to constructs a new DiscardFunding-variant Event
`boolean`	`eq(Event b)`	Checks if two Events contain equal inner contents.
`boolean`	`equals(Object o)`
`protected void`	`finalize()`
`static Event`	`funding_generation_ready(byte[] temporary_channel_id, byte[] counterparty_node_id, long channel_value_satoshis, byte[] output_script, UInt128 user_channel_id)`	Utility method to constructs a new FundingGenerationReady-variant Event
`static Event`	`htlchandling_failed(byte[] prev_channel_id, HTLCDestination failed_next_destination)`	Utility method to constructs a new HTLCHandlingFailed-variant Event
`static Event`	`htlcintercepted(byte[] intercept_id, long requested_next_hop_scid, byte[] payment_hash, long inbound_amount_msat, long expected_outbound_amount_msat)`	Utility method to constructs a new HTLCIntercepted-variant Event
`static Event`	`open_channel_request(byte[] temporary_channel_id, byte[] counterparty_node_id, long funding_satoshis, long push_msat, ChannelTypeFeatures channel_type)`	Utility method to constructs a new OpenChannelRequest-variant Event
`static Event`	`payment_claimable(byte[] receiver_node_id, byte[] payment_hash, RecipientOnionFields onion_fields, long amount_msat, long counterparty_skimmed_fee_msat, PaymentPurpose purpose, Option_ThirtyTwoBytesZ via_channel_id, Option_U128Z via_user_channel_id, Option_u32Z claim_deadline)`	Utility method to constructs a new PaymentClaimable-variant Event
`static Event`	`payment_claimed(byte[] receiver_node_id, byte[] payment_hash, long amount_msat, PaymentPurpose purpose, ClaimedHTLC[] htlcs, Option_u64Z sender_intended_total_msat)`	Utility method to constructs a new PaymentClaimed-variant Event
`static Event`	`payment_failed(byte[] payment_id, byte[] payment_hash, Option_PaymentFailureReasonZ reason)`	Utility method to constructs a new PaymentFailed-variant Event
`static Event`	`payment_forwarded(Option_ThirtyTwoBytesZ prev_channel_id, Option_ThirtyTwoBytesZ next_channel_id, Option_u64Z fee_earned_msat, boolean claim_from_onchain_tx, Option_u64Z outbound_amount_forwarded_msat)`	Utility method to constructs a new PaymentForwarded-variant Event
`static Event`	`payment_path_failed(Option_ThirtyTwoBytesZ payment_id, byte[] payment_hash, boolean payment_failed_permanently, PathFailure failure, Path path, Option_u64Z short_channel_id)`	Utility method to constructs a new PaymentPathFailed-variant Event
`static Event`	`payment_path_successful(byte[] payment_id, Option_ThirtyTwoBytesZ payment_hash, Path path)`	Utility method to constructs a new PaymentPathSuccessful-variant Event
`static Event`	`payment_sent(Option_ThirtyTwoBytesZ payment_id, byte[] payment_preimage, byte[] payment_hash, Option_u64Z fee_paid_msat)`	Utility method to constructs a new PaymentSent-variant Event
`static Event`	`pending_htlcs_forwardable(long time_forwardable)`	Utility method to constructs a new PendingHTLCsForwardable-variant Event
`static Event`	`probe_failed(byte[] payment_id, byte[] payment_hash, Path path, Option_u64Z short_channel_id)`	Utility method to constructs a new ProbeFailed-variant Event
`static Event`	`probe_successful(byte[] payment_id, byte[] payment_hash, Path path)`	Utility method to constructs a new ProbeSuccessful-variant Event
`static Event`	`spendable_outputs(SpendableOutputDescriptor[] outputs, Option_ThirtyTwoBytesZ channel_id)`	Utility method to constructs a new SpendableOutputs-variant Event
`byte[]`	`write()`	Serialize the Event object into a byte array which can be read by Event_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

clone
```
public Event clone()
```
Creates a copy of the Event

Overrides:

clone in class Object

funding_generation_ready

public static Event funding_generation_ready(byte[] temporary_channel_id,
                                             byte[] counterparty_node_id,
                                             long channel_value_satoshis,
                                             byte[] output_script,
                                             UInt128 user_channel_id)

Utility method to constructs a new FundingGenerationReady-variant Event

payment_claimable

public static Event payment_claimable(byte[] receiver_node_id,
                                      byte[] payment_hash,
                                      RecipientOnionFields onion_fields,
                                      long amount_msat,
                                      long counterparty_skimmed_fee_msat,
                                      PaymentPurpose purpose,
                                      Option_ThirtyTwoBytesZ via_channel_id,
                                      Option_U128Z via_user_channel_id,
                                      Option_u32Z claim_deadline)

Utility method to constructs a new PaymentClaimable-variant Event

payment_claimed

public static Event payment_claimed(byte[] receiver_node_id,
                                    byte[] payment_hash,
                                    long amount_msat,
                                    PaymentPurpose purpose,
                                    ClaimedHTLC[] htlcs,
                                    Option_u64Z sender_intended_total_msat)

Utility method to constructs a new PaymentClaimed-variant Event

payment_sent

public static Event payment_sent(Option_ThirtyTwoBytesZ payment_id,
                                 byte[] payment_preimage,
                                 byte[] payment_hash,
                                 Option_u64Z fee_paid_msat)

Utility method to constructs a new PaymentSent-variant Event

payment_failed

public static Event payment_failed(byte[] payment_id,
                                   byte[] payment_hash,
                                   Option_PaymentFailureReasonZ reason)

Utility method to constructs a new PaymentFailed-variant Event

payment_path_successful

public static Event payment_path_successful(byte[] payment_id,
                                            Option_ThirtyTwoBytesZ payment_hash,
                                            Path path)

Utility method to constructs a new PaymentPathSuccessful-variant Event

payment_path_failed

public static Event payment_path_failed(Option_ThirtyTwoBytesZ payment_id,
                                        byte[] payment_hash,
                                        boolean payment_failed_permanently,
                                        PathFailure failure,
                                        Path path,
                                        Option_u64Z short_channel_id)

Utility method to constructs a new PaymentPathFailed-variant Event

probe_successful

public static Event probe_successful(byte[] payment_id,
                                     byte[] payment_hash,
                                     Path path)

Utility method to constructs a new ProbeSuccessful-variant Event

probe_failed

public static Event probe_failed(byte[] payment_id,
                                 byte[] payment_hash,
                                 Path path,
                                 Option_u64Z short_channel_id)

Utility method to constructs a new ProbeFailed-variant Event

pending_htlcs_forwardable
```
public static Event pending_htlcs_forwardable(long time_forwardable)
```
Utility method to constructs a new PendingHTLCsForwardable-variant Event

htlcintercepted

public static Event htlcintercepted(byte[] intercept_id,
                                    long requested_next_hop_scid,
                                    byte[] payment_hash,
                                    long inbound_amount_msat,
                                    long expected_outbound_amount_msat)

Utility method to constructs a new HTLCIntercepted-variant Event

spendable_outputs

public static Event spendable_outputs(SpendableOutputDescriptor[] outputs,
                                      Option_ThirtyTwoBytesZ channel_id)

Utility method to constructs a new SpendableOutputs-variant Event

payment_forwarded

public static Event payment_forwarded(Option_ThirtyTwoBytesZ prev_channel_id,
                                      Option_ThirtyTwoBytesZ next_channel_id,
                                      Option_u64Z fee_earned_msat,
                                      boolean claim_from_onchain_tx,
                                      Option_u64Z outbound_amount_forwarded_msat)

Utility method to constructs a new PaymentForwarded-variant Event

channel_pending

public static Event channel_pending(byte[] channel_id,
                                    UInt128 user_channel_id,
                                    Option_ThirtyTwoBytesZ former_temporary_channel_id,
                                    byte[] counterparty_node_id,
                                    OutPoint funding_txo)

Utility method to constructs a new ChannelPending-variant Event

channel_ready

public static Event channel_ready(byte[] channel_id,
                                  UInt128 user_channel_id,
                                  byte[] counterparty_node_id,
                                  ChannelTypeFeatures channel_type)

Utility method to constructs a new ChannelReady-variant Event

channel_closed

public static Event channel_closed(byte[] channel_id,
                                   UInt128 user_channel_id,
                                   ClosureReason reason,
                                   byte[] counterparty_node_id,
                                   Option_u64Z channel_capacity_sats)

Utility method to constructs a new ChannelClosed-variant Event

discard_funding

public static Event discard_funding(byte[] channel_id,
                                    byte[] transaction)

Utility method to constructs a new DiscardFunding-variant Event

open_channel_request

public static Event open_channel_request(byte[] temporary_channel_id,
                                         byte[] counterparty_node_id,
                                         long funding_satoshis,
                                         long push_msat,
                                         ChannelTypeFeatures channel_type)

Utility method to constructs a new OpenChannelRequest-variant Event

htlchandling_failed

public static Event htlchandling_failed(byte[] prev_channel_id,
                                        HTLCDestination failed_next_destination)

Utility method to constructs a new HTLCHandlingFailed-variant Event

bump_transaction
```
public static Event bump_transaction(BumpTransactionEvent a)
```
Utility method to constructs a new BumpTransaction-variant Event

eq
```
public boolean eq(Event b)
```
Checks if two Events contain equal inner contents. This ignores pointers and is_owned flags and looks at the values in fields.

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

write
```
public byte[] write()
```
Serialize the Event object into a byte array which can be read by Event_read

Class Event