TransactionImportedEvent class - internals library

Constructors

TransactionImportedEvent({required String walletId, required String txid, required String rawHex, required int? blockHeight, required String bumpProof, required int totalOutputSats, required int numInputs, required int numOutputs, required int txVersion, required int txLockTime, required List<String> walletReceivingAddresses, required int walletReceivedSats, required int totalInputSats, required List<String> sendingAddresses, List<BeefAncestor> ancestors = const [], String? counterpartyMarker, String? memo, String? eventId, DateTime? timestamp, int? version, Map<String, dynamic>? metadata})

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
ancestors → List<BeefAncestor>: For a transaction received unproven (empty bumpProof): the ancestors its BEEF carried back to proven transactions, with their BUMPs, parents first (bead libspiffy-zsh). Empty for a proven transaction and for rows journaled before the field existed (the key is written only when not empty, so such rows and events without ancestors serialize as before).
final
blockHeight → int?: The block a verified merkle proof puts this transaction in, and null when nothing proves it is in one (bead libspiffy-nys0). An unproven import used to journal height 0 — the genesis block — because this could not hold an absence. Set together with bumpProof: a height here means the BUMP in bumpProof checked out against a header on our active chain, which is what "confirmed" means anywhere in this library (bead libspiffy-jc3h).
final
bumpProof → String: final
correlationId → String: The correlation ID of the message.
no setterinherited
counterpartyMarker → String?: The app's opaque marker for the counterparty this payment was with (bead libspiffy-cq16, spv-understanding.md "Core Data Management" requirement 5): an Ed25519 identity key, an email address, a peer id, an internal account id. libspiffy stores it and never interprets it. It is not an address and not the address-derived counterparty columns of the read model. Null when the app supplied none, and on rows journaled before the field existed, which replay unchanged: the key is written only when there is a marker, so an event without one serializes exactly as before.
final
eventId → String: Unique identifier for this event Used for deduplication and correlation
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
memo → String?: The payment's note, written by the payer for the payee. libspiffy journals it and returns it and never interprets it. Null when none, and on rows journaled before the field existed, which replay unchanged: the key is written only when there is a memo.
final
metadata → Map<String, dynamic>: Additional metadata for the event Can include correlation IDs, causation IDs, user context, etc.
no setterinherited
numInputs → int: final
numOutputs → int: final
persistableMetadata → Map<String, dynamic>: metadata as it is persisted: transient ActorRef entries removed.
no setterinherited
rawHex → String: final
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
sendingAddresses → List<String>: final
timestamp → DateTime: Timestamp when the event occurred
no setterinherited
totalInputSats → int: final
totalOutputSats → int: final
txid → String: final
txLockTime → int: final
txVersion → int: final
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
walletId → String: ID of the wallet this event belongs to (same as aggregateId)
no setterinherited
walletReceivedSats → int: final
walletReceivingAddresses → List<String>: final

Methods

getEventData() → Map<String, dynamic>: Implementation of SerializableEvent.getEventData
inherited
getValidationErrors() → List<String>: Get validation errors Override in subclasses to provide specific error messages
inherited
getWalletEventData() → Map<String, dynamic>: Wallet-specific event data (to be implemented by concrete events)
override
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

Static Methods

fromMap(Map<String, dynamic> map) → TransactionImportedEvent: Create event from a map during deserialization This is a factory method that should be implemented by concrete event classes

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).