Skip to content

@armada/sdk / index / HistoryEntry

Interface: HistoryEntry ​

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

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:33


blockNumber ​

readonly blockNumber: number

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


category ​

readonly category: HistoryCategory

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


tokenHash ​

readonly tokenHash: string

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

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:38


value ​

readonly value: bigint

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


broadcasterFee? ​

readonly optional broadcasterFee?: bigint

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

Relayer fee PAID (gross) — the in-band broadcaster fee on sends/unshields, or, on a gasless shield (issue #88 lever 2), the relayer fee note's GROSS: its value + its own protocol shield fee, i.e. what the user paid the relayer. Populated in H3 (sends) / from the Shield event (shields).


broadcasterShieldedAddress? ​

readonly optional broadcasterShieldedAddress?: string

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

The broadcaster's shielded (0zk) address that the fee note paid — recovered sender-side.


shieldFee? ​

readonly optional shieldFee?: bigint

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

Shield fee charged (shield receives).


unshieldFee? ​

readonly optional unshieldFee?: bigint

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

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


shares? ​

readonly optional shares?: bigint

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

Vault shares redeemed (yield-withdraw entries) — the vault-token amount unshielded to the adapter. Surfaced on the USDC leg so a consumer that keeps only the USDC leg still sees the share count.


recipient? ​

readonly optional recipient?: string

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

Public recipient address (unshield entries).


senderShieldedAddress? ​

readonly optional senderShieldedAddress?: string

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

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


selfMetadata? ​

readonly optional selfMetadata?: string

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

Caller metadata recovered from the spend's change-note memo (issue #88 lever 3) — the opaque blob passed to prove({ selfMetadata }), reproduced on a fresh scan even after local storage is cleared. A yield withdrawal's change note is a share note; its USDC leg carries the blob too (issue #113).


sentOutputs? ​

readonly optional sentOutputs?: readonly SentRecipient[]

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

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:63


timestamp? ​

readonly optional timestamp?: number

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

Unix seconds — the block's, recorded during sync and attached by wallet.history(); absent in the pure reconstruction, or when the node didn't return the block.