UseLedgerUpdatesOptions
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:74
Properties
Section titled “Properties”enabled?
Section titled “enabled?”
optionalenabled:boolean
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:78
Whether to enable updates (default: true when connected)
initialOffset?
Section titled “initialOffset?”
optionalinitialOffset:string
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:86
Initial offset to start polling from (skips ledger-end fetch if provided)
maxHistory?
Section titled “maxHistory?”
optionalmaxHistory:number
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:84
Maximum updates to keep in history (default: 100)
onUpdate()?
Section titled “onUpdate()?”
optionalonUpdate: (updates) =>void
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:82
Callback when new updates arrive
Parameters
Section titled “Parameters”updates
Section titled “updates”Returns
Section titled “Returns”void
pollingInterval?
Section titled “pollingInterval?”
optionalpollingInterval:number
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:76
Polling interval in milliseconds (default: 2000)
templateFilter?
Section titled “templateFilter?”
optionaltemplateFilter:CantonTemplateFilter
Defined in: packages/react/src/hooks/useLedgerUpdates.ts:80
Template filter to limit updates to specific templates