Skip to main content

Crate sui_rpc_api

Crate sui_rpc_api 

Source

Re-exports§

pub use client::Client;

Modules§

client
grpc
ledger_history
proto
read_mask_defaults
subscription

Structs§

AtCheckpointLowerBound
See StateReader::at_checkpoint_lower_bound.
AtCheckpointUpperBound
See StateReader::at_checkpoint_upper_bound. Read once per request so that a batch checks every item against the same bound. Other implementors of the rpc services build it with Self::new from the height they serve (e.g. sui-kv-rpc’s served height), so every backend applies the same check.
CheckpointNotFoundError
Config
EpochNotFoundError
ErrorDetails
ObjectNotFoundError
ObjectRemoval
The deletion or wrap a read resolved to: the object is not found because the version the read selected removed it from the live set. Servers describe a removal only when they find it (see ObjectNotFoundError::removed). The removing transaction is not part of it: ListObjectVersions lists it when the request’s removal_read_mask names transaction.
RpcError
An error encountered while serving an RPC request.
RpcMetrics
RpcMetricsMakeCallbackHandler
RpcService
ServerVersion
TransactionNotFoundError

Enums§

Direction
ErrorReason
Error reasons in the sui.io error domain, used as the reason of a google.rpc.ErrorInfo or of a google.rpc.BadRequest.FieldViolation.
NotReadyCause
The cause of a NOT_READY refusal: the temporary state that keeps this node from serving a request it will serve once the state clears.
NotServedHereCause
The cause of a NOT_SERVED_HERE refusal: why this node does not serve a request. The same request to the same node always fails the same way, so clients do not retry it there.

Constants§

X_SUI_CLIENT_PROTOCOL_VERSION
Request header carrying the highest protocol version whose types the client can decode.
X_SUI_FINALITY_LEVEL
Request header naming the least settled data a request accepts: executed or certified.

Functions§

client_protocol_version
The highest protocol version the client that sent a request understands, if it said.
grpc_method_paths_from_file_descriptor_sets
Decode one or more encoded FileDescriptorSet byte slices and return the set of /package.Service/Method paths they declare.
not_ready
A refusal for a request this node cannot serve now but will: Unavailable with a NOT_READY ErrorInfo whose cause metadata is cause.
not_served_here
A refusal for a request this node is not set up for: Unimplemented with a NOT_SERVED_HERE ErrorInfo whose cause metadata is cause.

Type Aliases§

GrpcMethodAllowlist
Set of /package.Service/Method paths that are safe to use as metric labels.
Result