Expand description
High-level API for gRPC client operations.
This module provides wrappers around the raw gRPC service clients. Proto types are exposed directly with lazy conversion methods, allowing users to convert only what they need to SDK types.
Modules§
- execution
- High-level API for TransactionExecutionService operations.
- ledger
- High-level API for LedgerService operations.
- move_
package - High-level API for MovePackageService operations.
- state
- High-level API for StateService operations.
Structs§
- Checkpoint
Response - Response for a checkpoint query.
- Metadata
Envelope - A response from the gRPC API that carries both the response body and metadata headers.
- Page
- A single page of results from a paginated list endpoint.
- RpcStatus
- The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. EachStatusmessage contains three pieces of data: error code, error message, and error details.
Enums§
- Checkpoint
Stream Item - An item from a checkpoint data stream.
- Error
- Errors that can occur during gRPC client API operations.
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(), andSimulatedTransaction::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().
Type Aliases§
- Result
- Result type alias for API operations.