Module read_masks

Expand description

Read mask constants for the gRPC API.

This module provides two categories of constants:

§Endpoint defaults

Constants like GET_CHECKPOINT_READ_MASK are the canonical defaults used by both the server (as fallback when no mask is provided) and the client (when None is passed as the mask).

§Per-method field constants

Constants like CHECKPOINT_RESPONSE_SUMMARY or EXECUTED_TRANSACTION_EFFECTS represent the read mask field(s) required by a specific accessor method on a response type. Pass one or more of these to the endpoint’s read_mask parameter to ensure the accessor will succeed.

§Context-dependent paths

ExecutedTransaction appears in multiple endpoints with different field-path prefixes:

Endpoint	Prefix
`get_transactions` / `execute_transactions`	(none — direct)
Checkpoint queries	`transactions.`
`simulate_transactions`	`executed_transaction.`

The EXECUTED_TRANSACTION_* constants use the direct (unprefixed) paths. For checkpoint or simulate contexts, prepend the appropriate prefix. The CHECKPOINT_RESPONSE_* constants already include the transactions. or checkpoint. prefix for convenience.

Individual fields can be requested using dot notation. Pass a custom mask to narrow or widen the response; the endpoint defaults serve as a baseline that covers the most commonly needed fields.

Constants§

CHECKPOINT_CONTENTS_BCS: Read mask for CheckpointContents::contents().
CHECKPOINT_CONTENTS_DIGEST: Read mask for CheckpointContents::digest().
CHECKPOINT_RESPONSE_CHECKPOINT_DATA: Read mask for CheckpointResponse::checkpoint_data().
CHECKPOINT_RESPONSE_CONTENTS: Read mask for CheckpointResponse::contents().
CHECKPOINT_RESPONSE_EVENTS: Read mask for CheckpointResponse::events().
CHECKPOINT_RESPONSE_EXECUTED_TRANSACTIONS: Read mask for CheckpointResponse::executed_transactions().
CHECKPOINT_RESPONSE_SIGNATURE: Read mask for CheckpointResponse::signature().
CHECKPOINT_RESPONSE_SIGNED_SUMMARY: Read mask for CheckpointResponse::signed_summary().
CHECKPOINT_RESPONSE_SUMMARY: Read mask for CheckpointResponse::summary().
CHECKPOINT_SUMMARY_BCS: Read mask for CheckpointSummary::summary().
CHECKPOINT_SUMMARY_DIGEST: Read mask for CheckpointSummary::digest().
EVENT_BCS: Read mask for Event::event() (full BCS deserialization).
EVENT_BCS_CONTENTS: Read mask for Event::bcs_contents().
EVENT_JSON_CONTENTS: Read mask for Event::json_contents().
EVENT_MODULE: Read mask for Event::module_name().
EVENT_PACKAGE_ID: Read mask for Event::package_id().
EVENT_SENDER: Read mask for Event::sender().
EVENT_TYPE: Read mask for Event::type_name().
EXECUTED_TRANSACTION_CHECKPOINT: Read mask for ExecutedTransaction::checkpoint_sequence_number().
EXECUTED_TRANSACTION_EFFECTS: Read mask for ExecutedTransaction::effects().
EXECUTED_TRANSACTION_EVENTS: Read mask for ExecutedTransaction::events().
EXECUTED_TRANSACTION_INPUT_OBJECTS: Read mask for ExecutedTransaction::input_objects().
EXECUTED_TRANSACTION_OUTPUT_OBJECTS: Read mask for ExecutedTransaction::output_objects().
EXECUTED_TRANSACTION_SIGNATURES: Read mask for ExecutedTransaction::signatures().
EXECUTED_TRANSACTION_TIMESTAMP: Read mask for ExecutedTransaction::timestamp_ms().
EXECUTED_TRANSACTION_TRANSACTION: Read mask for ExecutedTransaction::transaction().
EXECUTE_TRANSACTIONS_READ_MASK: Default read mask for execute_transactions.
EXECUTION_ERROR_BCS_KIND: Read mask for ExecutionError::error_kind().
EXECUTION_ERROR_COMMAND_INDEX: Read mask for ExecutionError::error_command_index().
EXECUTION_ERROR_SOURCE: Read mask for ExecutionError::error_source().
GET_CHECKPOINT_READ_MASK: Default read mask for get_checkpoint / stream_checkpoints.
GET_EPOCH_READ_MASK: Default read mask for get_epoch.
GET_OBJECTS_READ_MASK: Default read mask for get_objects.
GET_SERVICE_INFO_READ_MASK: Default read mask for get_service_info.
GET_TRANSACTIONS_READ_MASK: Default read mask for get_transactions.
LIST_DYNAMIC_FIELDS_READ_MASK: Default read mask for list_dynamic_fields.
LIST_OWNED_OBJECTS_READ_MASK: Default read mask for list_owned_objects.
OBJECT_BCS: Read mask for Object::object() (BCS deserialization).
OBJECT_REFERENCE: Read mask for Object::object_reference().
SIMULATED_TRANSACTION_EXECUTED_TRANSACTION: Read mask for SimulatedTransaction::executed_transaction().
SIMULATED_TRANSACTION_EXECUTION_RESULT: Read mask for SimulatedTransaction::execution_result(), SimulatedTransaction::command_results(), and SimulatedTransaction::execution_error().
SIMULATED_TRANSACTION_SUGGESTED_GAS_PRICE: Read mask for SimulatedTransaction::gas_price_suggested().
SIMULATE_TRANSACTIONS_READ_MASK: Default read mask for simulate_transactions.
TRANSACTION_BCS: Read mask for Transaction::transaction() (BCS deserialization).
TRANSACTION_DIGEST: Read mask for Transaction::digest().
TRANSACTION_EFFECTS_BCS: Read mask for TransactionEffects::effects() (BCS deserialization).
TRANSACTION_EFFECTS_DIGEST: Read mask for TransactionEffects::digest().
TRANSACTION_EVENTS_BCS: Read mask for TransactionEvents::events() (BCS deserialization of all events).
TRANSACTION_EVENTS_DIGEST: Read mask for TransactionEvents::digest().