ChannelExpiredEvent class

Channel has expired (lockTime elapsed).

Emitted when a channel's lockTime has passed and the periodic expiry monitor records the expiry through the aggregate. Distinct from:

ChannelClosedEvent: cooperative close via settlement TX.
RefundClaimedEvent: client successfully reclaimed funding via refund TX.

This event captures the read-model transition to expired regardless of whether a refund/settlement TX was broadcast. The optional settlementOrRefundTxId records the broadcast txid if any (best-effort — the broadcast itself is handled out-of-band by the expiry manager).

Inheritance

Object
ChannelEvent
ChannelExpiredEvent

Constructors

ChannelExpiredEvent({required String channelId, required String observedBy, String? settlementOrRefundTxId, String? eventId, DateTime? timestamp, int? version, Map<String, dynamic>? metadata})
ChannelExpiredEvent.fromMap(Map<String, dynamic> map): factory

Properties

aggregateId → String: The ID of the aggregate this event belongs to
no setterinherited
aggregateType → String: The type of aggregate this event belongs to
no setterinherited
channelId → String: finalinherited
correlationId → String: The correlation ID of the message.
no setterinherited
eventId → String: Unique identifier for this event Used for deduplication and correlation
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
metadata → Map<String, dynamic>: Additional metadata for the event Can include correlation IDs, causation IDs, user context, etc.
no setterinherited
observedBy → String: 'client' or 'server' — captures which side observed and recorded the expiry.
final
persistableMetadata → Map<String, dynamic>: metadata as it is persisted: transient ActorRef entries removed.
no setterinherited
replyTo → ActorRef?: The actor to reply to, if a live ActorRef was placed in metadata['replyTo'].
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
settlementOrRefundTxId → String?: Optional txid of refund (client) or settlement (server) TX broadcast in response to the expiry. Null when nothing was broadcast (e.g., no refund TX available, or server received no payments).
final
timestamp → DateTime: Timestamp when the event occurred
no setterinherited
typeName → String: Stable identity of this event type in storage.
no setter
version → int: Version/sequence number of this event within its aggregate Used for ordering and optimistic concurrency control
no setterinherited

Methods

getChannelEventData() → Map<String, dynamic>: Override to provide event-specific data for serialization
override
getEventData() → Map<String, dynamic>: Get event-specific data for serialization Override in subclasses to provide event data
inherited
getValidationErrors() → List<String>: Get validation errors Override in subclasses to provide specific error messages
inherited
isValid() → bool: Validate the event Override in subclasses for custom validation
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toCbor() → List<int>: Serialize event to CBOR bytes
inherited
toMap() → Map<String, dynamic>: Convert event to a map for serialization Override in subclasses to include event-specific data
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Constants

stableTypeName → const String: Journal identifier of this event type. Stored with every event and independent of the class name; never change it (audit 2026-09-14 M8).