Expand description
High-level API for checkpoint queries.
§Available Read Mask Fields
All checkpoint query methods support the following read_mask fields to
control which data is included in the response:
§Checkpoint Fields
checkpoint- includes all checkpoint fieldscheckpoint.sequence_number- the sequence number of the checkpointcheckpoint.summary- includes all checkpoint summary fieldscheckpoint.summary.digest- the digest of the checkpoint summarycheckpoint.summary.bcs- the full BCS-encoded checkpoint summary
checkpoint.contents- includes all checkpoint contents fieldscheckpoint.contents.digest- the digest of the checkpoint contentscheckpoint.contents.bcs- the full BCS-encoded checkpoint contents
checkpoint.signature- the validator aggregated signature for the checkpoint
§Transaction Fields
transactions- includes all executed transaction fieldstransactions.transaction- includes all transaction fieldstransactions.transaction.digest- the transaction digesttransactions.transaction.bcs- the full BCS-encoded transaction
transactions.signatures- includes all signature fieldstransactions.signatures.bcs- the full BCS-encoded signature
transactions.effects- includes all effects fieldstransactions.effects.digest- the effects digesttransactions.effects.bcs- the full BCS-encoded effects
transactions.events- includes all event fields (all events of the transaction)transactions.events.digest- the events digesttransactions.events.events- includes all event fieldstransactions.events.events.bcs- the full BCS-encoded eventtransactions.events.events.package_id- the ID of the package that emitted the eventtransactions.events.events.module- the module that emitted the eventtransactions.events.events.sender- the sender that triggered the eventtransactions.events.events.event_type- the type of the eventtransactions.events.events.bcs_contents- the full BCS-encoded contents of the eventtransactions.events.events.json_contents- the JSON-encoded contents of the event
transactions.checkpoint- the checkpoint that included the transactiontransactions.timestamp- the timestamp of the checkpoint that included the transactiontransactions.input_objects- includes all input object fieldstransactions.input_objects.reference- includes all reference fieldstransactions.input_objects.reference.object_id- the ID of the input objecttransactions.input_objects.reference.version- the version of the input objecttransactions.input_objects.reference.digest- the digest of the input object contents
transactions.input_objects.bcs- the full BCS-encoded object
transactions.output_objects- includes all output object fieldstransactions.output_objects.reference- includes all reference fieldstransactions.output_objects.reference.object_id- the ID of the output objecttransactions.output_objects.reference.version- the version of the output objecttransactions.output_objects.reference.digest- the digest of the output object contents
transactions.output_objects.bcs- the full BCS-encoded object
§Event Fields
events- includes all event fields (all events of all transactions in the checkpoint)events.bcs- the full BCS-encoded eventevents.package_id- the ID of the package that emitted the eventevents.module- the module that emitted the eventevents.sender- the sender that triggered the eventevents.event_type- the type of the eventevents.bcs_contents- the full BCS-encoded contents of the eventevents.json_contents- the JSON-encoded contents of the event