TransferSummary

data class TransferSummary(val direction: TransferDirection, val counterparty: String?, val instrumentId: InstrumentId, val amount: BigDecimal, val memo: String?)

Transfer-level reading of one holdings-history update: direction, counterparty, the signed net effect on the wallet party's balance, and the memo when the transfer carried one.

Derived from the update's TransferInstruction interface views when present (sender/receiver/memo are then explicit) and from per-owner holding deltas otherwise. amount is the net of the party's created minus archived holdings for instrumentId — for a sender this is more negative than the transfer amount because fees ride on the same update.

Constructors

Link copied to clipboard
constructor(direction: TransferDirection, counterparty: String?, instrumentId: InstrumentId, amount: BigDecimal, memo: String?)

Properties

Link copied to clipboard

Signed net effect on the wallet party's balance for instrumentId: credits positive, debits negative. Fee-inclusive by construction.

Link copied to clipboard

The other party of the transfer — receiver when direction is TransferDirection.SENT, sender when TransferDirection.RECEIVED, null when no counterparty is determinable.

Link copied to clipboard

How the update moved value relative to the wallet party.

Link copied to clipboard

The instrument whose balance the update changed.

Link copied to clipboard
val memo: String?

The transfer's human-readable reason, from the splice.lfdecentralizedtrust.org/reason metadata key when present.