Read the ledger’s filtered update stream for the specified contents and filters.
It returns the event types in accordance with the stream contents selected. Also the selection criteria
for individual events depends on the transaction shape chosen.
- ACS delta: a requesting party must be a stakeholder of an event for it to be included.
- ledger effects: a requesting party must be a witness of an event for it to be included.
Protocol Details
Inputs
Outputs
Either_JsCantonError_JsGetUpdatesResponse
Variants
JsCantonError
object
codestringrequiredcausestringrequiredcontextobjectrequirederrorCategorystringrequiredRelated Schemas
Either_JsCantonError_JsGetUpdatesResponse
Either_JsCantonError_JsGetUpdatesResponse
Variants
JsCantonError
object
codestringrequiredcausestringrequiredcontextobjectrequirederrorCategorystringrequiredJsGetUpdatesResponse
object
updateobjectVariants
update
oneOf
OffsetCheckpointobjectVariants
OffsetCheckpoint
object
OffsetCheckpointobjectrequiredReassignment
object
ReassignmentobjectrequiredTopologyTransaction
object
TopologyTransactionobjectrequiredTransaction
object
TransactionobjectrequiredHistory
Updated
3.5channel description updated; subscribe description updated
Added
3.4wscat
wscat
messageapplication/json
message