@armada/sdk / index / HistoryEntry

Interface: HistoryEntry

Defined in: src/sync/history.ts:30

One value movement the wallet participated in. Flat per (txid, owned-note) — a consumer groups by txid for a per-transaction view. value is the wallet delta for tokenAddress: positive for receives, negative for sends (set by later phases). Amounts are token base units.

Properties

txid

readonly txid: string

Defined in: src/sync/history.ts:31

---

blockNumber

readonly blockNumber: number

Defined in: src/sync/history.ts:32

---

category

readonly category: HistoryCategory

Defined in: src/sync/history.ts:33

---

tokenHash

readonly tokenHash: string

Defined in: src/sync/history.ts:35

Canonical 32-byte token hash (no 0x) — the identifier balances() and the token events join on.

---

tokenAddress

readonly tokenAddress: `0x${string}`

Defined in: src/sync/history.ts:36

---

value

readonly value: bigint

Defined in: src/sync/history.ts:37

---

broadcasterFee?

readonly optional broadcasterFee?: bigint

Defined in: src/sync/history.ts:39

Relayer fee paid (sends/unshields) — the in-band broadcaster fee. Populated in H3.

---

shieldFee?

readonly optional shieldFee?: bigint

Defined in: src/sync/history.ts:41

Shield fee charged (shield receives).

---

unshieldFee?

readonly optional unshieldFee?: bigint

Defined in: src/sync/history.ts:43

Protocol unshield fee (unshield entries) — from the on-chain Unshield event.

---

recipient?

readonly optional recipient?: string

Defined in: src/sync/history.ts:45

Public recipient address (unshield entries).

---

senderShieldedAddress?

readonly optional senderShieldedAddress?: string

Defined in: src/sync/history.ts:47

Sender's 0zk, if they disclosed it (transfer receives).

---

sentOutputs?

readonly optional sentOutputs?: readonly SentRecipient[]

Defined in: src/sync/history.ts:49

Recipient outputs of a send (transfer-sent), recovered sender-side — recipient 0zk + amount + memo.

---

memo?

readonly optional memo?: string

Defined in: src/sync/history.ts:50

---

timestamp?

readonly optional timestamp?: number

Defined in: src/sync/history.ts:52

Unix seconds — attached by wallet.history() from the block; absent in the pure reconstruction.