Skip to content

@armada/sdk / index / TXO

Interface: TXO ​

Defined in: src/sync/balances.ts:14

Properties ​

tree ​

readonly tree: number

Defined in: src/sync/balances.ts:15


position ​

readonly position: number

Defined in: src/sync/balances.ts:16


tokenHash ​

readonly tokenHash: string

Defined in: src/sync/balances.ts:17


value ​

readonly value: bigint

Defined in: src/sync/balances.ts:18


blockNumber ​

readonly blockNumber: number

Defined in: src/sync/balances.ts:19


txid ​

readonly txid: string

Defined in: src/sync/balances.ts:21

Transaction that created this commitment — groups a wallet's receives per tx for history.


origin ​

readonly origin: NoteOrigin

Defined in: src/sync/balances.ts:23

Which event created it — distinguishes a received shield from a received transfer/change.


memo? ​

readonly optional memo?: string

Defined in: src/sync/balances.ts:25

Memo the sender attached (transfer receives), if any.


senderShieldedAddress? ​

readonly optional senderShieldedAddress?: string

Defined in: src/sync/balances.ts:27

Sender's 0zk, present only if disclosed (transfer receives).


shieldFee? ​

readonly optional shieldFee?: bigint

Defined in: src/sync/balances.ts:29

The shield fee charged on this deposit (shield origin only) — from the Shield event's fees.


random ​

readonly random: string

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

16-byte note random (hex, no 0x) — required to rebuild the spend witness (randomIn).


notePublicKey ​

readonly notePublicKey: bigint

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

Note public key poseidon(masterPublicKey, random) — the commitment's npk.