package sui.rpc.consistent.v1alpha

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc AvailableRange (AvailableRangeRequest, AvailableRangeResponse)

  consistent_service.proto:9

  message AvailableRangeRequest

  consistent_service.proto:25

  (message has no fields)

  message AvailableRangeResponse

  consistent_service.proto:27

  • optional uint64 min_checkpoint = 1

    The (inclusive) minimum checkpoint sequence number that the service can answer questions for.

  • optional uint64 max_checkpoint = 100

    The (inclusive) maximum checkpoint sequence number that the service can answer questions for.

  • optional uint64 max_epoch = 101

    The (inclusive) maximum epoch that the service can answer questions for.

  • optional uint64 total_transactions = 102

    The total number of transactions that have executed on chain by the end of the `max_checkpoint`.

  • optional uint64 max_timestamp_ms = 103

    The (inclusive) maximum timestamp that the service can answer questions for, in milliseconds since the Unix epoch.

  • optional uint64 stride = 200

    The gaps between snapshots taken by the service, measured in checkpoints. Accessible checkpoints in the available range are evenly spaced out `stride` checkpoints apart.

• rpc BatchGetBalances (BatchGetBalancesRequest, BatchGetBalancesResponse)

  consistent_service.proto:11

  message BatchGetBalancesRequest

  consistent_service.proto:53

  • repeated GetBalanceRequest requests = 1

  message BatchGetBalancesResponse

  consistent_service.proto:55

  • repeated Balance balances = 1

• rpc GetBalance (GetBalanceRequest, Balance)

  consistent_service.proto:14

• rpc ListBalances (ListBalancesRequest, ListBalancesResponse)

  consistent_service.proto:16

  message ListBalancesRequest

  consistent_service.proto:66

  • optional string owner = 1

    Required. The address of the owner whose balances are being requested.

  • optional uint32 page_size = 100

    The maximum number of entries to return. The service may return fewer than this value. Consult `sui.rpc.consistent.v1alpha/ServiceConfig` for default and maximum page sizes.

  • optional bytes after_token = 101

    A page token, received from a previous `ListOwnedObjects` call. Provide this to retrieve the next page.

  • optional bytes before_token = 102

    A page token, received from a previous `ListOwnedObjects` call. Provide this to retrieve the previous page.

  • optional End end = 103

    Whether to fetch the next page from the front or back of the filtered range.

  message ListBalancesResponse

  consistent_service.proto:90

  • optional bool has_previous_page = 1

    Whether there are more pages before this one.

  • optional bool has_next_page = 2

    Whether there are more pages after this one.

  • repeated Balance balances = 3

    Page of balances owned by the specified owner.

• rpc ListObjectsByType (ListObjectsByTypeRequest, ListObjectsResponse)

  consistent_service.proto:18

  message ListObjectsByTypeRequest

  consistent_service.proto:101

  • optional string object_type = 1

    Required. Type filter to limit the types of objects listed. Accepts filters by the type's package, module, fully-qualified name, or a type instantiation: - `0x2` - `0x2::coin` - `0x2::coin::Coin` - `0x2::coin::Coin<0x2::sui::SUI>`

  • optional uint32 page_size = 100

    The maximum number of entries to return. The service may return fewer than this value. Consult `sui.rpc.consistent.v1alpha/ServiceConfig` for default and maximum page sizes.

  • optional bytes after_token = 101

    A page token, received from a previous `ListOwnedObjects` call. Provide this to retrieve the next page.

  • optional bytes before_token = 102

    A page token, received from a previous `ListOwnedObjects` call. Provide this to retrieve the previous page.

  • optional End end = 103

    Whether to fetch the next page from the front or back of the filtered range.

• rpc ListOwnedObjects (ListOwnedObjectsRequest, ListObjectsResponse)

  consistent_service.proto:20

  message ListOwnedObjectsRequest

  consistent_service.proto:133

  • optional Owner owner = 1

    Required. The owner kind and address.

  • optional string object_type = 2

    Optional type filter to limit the types of objects listed. Accepts filters by the type's package, module, fully-qualified name, or a type instantiation: - `0x2` - `0x2::coin` - `0x2::coin::Coin` - `0x2::coin::Coin<0x2::sui::SUI>`

  • optional uint32 page_size = 100

    The maximum number of entries to return. The service may return fewer than this value. Consult `sui.rpc.consistent.v1alpha/ServiceConfig` for default and maximum page sizes.

  • optional bytes after_token = 101

    A page token, received from a previous `ListOwnedObjects` call. Provide this to retrieve the next page.

  • optional bytes before_token = 102

    A page token, received from a previous `ListOwnedObjects` call. Provide this to retrieve the previous page.

  • optional End end = 103

    Whether to fetch the next page from the front or back of the filtered range.

• rpc ServiceConfig (ServiceConfigRequest, ServiceConfigResponse)

  consistent_service.proto:22

  message ServiceConfigRequest

  consistent_service.proto:179

  (message has no fields)

  message ServiceConfigResponse

  consistent_service.proto:181

  • optional uint32 default_page_size = 1

    The size of a page if one is not specified in the request.

  • optional uint32 max_batch_size = 2

    The maximum number of requests allowed in a batch request.

  • optional uint32 max_page_size = 3

    The maximum size of a page. Responses to requests that specify a size larger than this will be capped to return at most this many elements per page.

Used as response type in: ConsistentService.GetBalance

Used as field type in: BatchGetBalancesResponse, ListBalancesResponse

• optional string owner = 1

  Address of the owner whose balance is being reported.

• optional string coin_type = 2

  The marker type for the coins being aggregated into this balance, e.g. `0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI`.

• optional uint64 balance = 3

  / The total balance for coins of this type, owned by one address, denominated in its smallest unit.

• optional bytes page_token = 100

  Pagination cursor pointing to this balance entry, if this Balance is part of a paginated response.

The side of the filtered range to fetch the next page from.

Used in: ListBalancesRequest, ListObjectsByTypeRequest, ListOwnedObjectsRequest

• END_UNKNOWN = 0

• FRONT = 1

• BACK = 2

Used as request type in: ConsistentService.GetBalance

Used as field type in: BatchGetBalancesRequest

• optional string owner = 1

  Required. The address of the owner whose balance is being requested.

• optional string coin_type = 2

  Required. The marker type for the coins being aggregated into this balance, e.g. `0x2::sui::SUI`.

Used as response type in: ConsistentService.ListObjectsByType, ConsistentService.ListOwnedObjects

• optional bool has_previous_page = 1

  Whether there are more pages before this one.

• optional bool has_next_page = 2

  Whether there are more pages after this one.

• repeated Object objects = 3

  Page of objects owned by the specified owner.

Used in: ListObjectsResponse

• optional string object_id = 1

• optional uint64 version = 2

• optional string digest = 3

• optional bytes page_token = 100

Enum of different types of ownership for an object.

Used in: ListOwnedObjectsRequest

• optional Owner.OwnerKind kind = 1

• optional string address = 2

  Address or ObjectId of the owner

Used in: Owner

• OWNER_KIND_UNKNOWN = 0

• ADDRESS = 1

• OBJECT = 2

• SHARED = 3

• IMMUTABLE = 4