Skip to content
Sigilry Sigilry Sigilry

UseLedgerUpdatesOptions

Defined in: packages/react/src/hooks/useLedgerUpdates.ts:68

Properties

Section titled “Properties”

enabled?

Section titled “enabled?”

optional enabled: boolean

Defined in: packages/react/src/hooks/useLedgerUpdates.ts:72

Whether to enable updates (default: true when connected)

initialOffset?

Section titled “initialOffset?”

optional initialOffset: string

Defined in: packages/react/src/hooks/useLedgerUpdates.ts:80

Initial offset to start polling from (skips ledger-end fetch if provided)

maxHistory?

Section titled “maxHistory?”

optional maxHistory: number

Defined in: packages/react/src/hooks/useLedgerUpdates.ts:78

Maximum updates to keep in history (default: 100)

onUpdate()?

Section titled “onUpdate()?”

optional onUpdate: (updates) => void

Defined in: packages/react/src/hooks/useLedgerUpdates.ts:76

Callback when new updates arrive

Parameters

Section titled “Parameters”
updates
Section titled “updates”

TransactionUpdate[]

Returns

Section titled “Returns”

void

pollingInterval?

Section titled “pollingInterval?”

optional pollingInterval: number

Defined in: packages/react/src/hooks/useLedgerUpdates.ts:70

Polling interval in milliseconds (default: 2000)

templateFilter?

Section titled “templateFilter?”

optional templateFilter: CantonTemplateFilter

Defined in: packages/react/src/hooks/useLedgerUpdates.ts:74

Template filter to limit updates to specific templates