@clonegod/ttd-sui-common 1.0.5 → 1.0.7

package/dist/grpc/protos/google/protobuf/timestamp.proto

@@ -0,0 +1,144 @@
+// Protocol Buffers - Google's data interchange format
+// Copyright 2008 Google Inc.  All rights reserved.
+// https://developers.google.com/protocol-buffers/
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//     * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//     * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//     * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+syntax = "proto3";
+
+package google.protobuf;
+
+option cc_enable_arenas = true;
+option go_package = "google.golang.org/protobuf/types/known/timestamppb";
+option java_package = "com.google.protobuf";
+option java_outer_classname = "TimestampProto";
+option java_multiple_files = true;
+option objc_class_prefix = "GPB";
+option csharp_namespace = "Google.Protobuf.WellKnownTypes";
+
+// A Timestamp represents a point in time independent of any time zone or local
+// calendar, encoded as a count of seconds and fractions of seconds at
+// nanosecond resolution. The count is relative to an epoch at UTC midnight on
+// January 1, 1970, in the proleptic Gregorian calendar which extends the
+// Gregorian calendar backwards to year one.
+//
+// All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+// second table is needed for interpretation, using a [24-hour linear
+// smear](https://developers.google.com/time/smear).
+//
+// The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
+// restricting to that range, we ensure that we can convert to and from [RFC
+// 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
+//
+// # Examples
+//
+// Example 1: Compute Timestamp from POSIX `time()`.
+//
+//     Timestamp timestamp;
+//     timestamp.set_seconds(time(NULL));
+//     timestamp.set_nanos(0);
+//
+// Example 2: Compute Timestamp from POSIX `gettimeofday()`.
+//
+//     struct timeval tv;
+//     gettimeofday(&tv, NULL);
+//
+//     Timestamp timestamp;
+//     timestamp.set_seconds(tv.tv_sec);
+//     timestamp.set_nanos(tv.tv_usec * 1000);
+//
+// Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
+//
+//     FILETIME ft;
+//     GetSystemTimeAsFileTime(&ft);
+//     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+//
+//     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+//     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+//     Timestamp timestamp;
+//     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+//     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+//
+// Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
+//
+//     long millis = System.currentTimeMillis();
+//
+//     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+//         .setNanos((int) ((millis % 1000) * 1000000)).build();
+//
+// Example 5: Compute Timestamp from Java `Instant.now()`.
+//
+//     Instant now = Instant.now();
+//
+//     Timestamp timestamp =
+//         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+//             .setNanos(now.getNano()).build();
+//
+// Example 6: Compute Timestamp from current time in Python.
+//
+//     timestamp = Timestamp()
+//     timestamp.GetCurrentTime()
+//
+// # JSON Mapping
+//
+// In JSON format, the Timestamp type is encoded as a string in the
+// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+// format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
+// where {year} is always expressed using four digits while {month}, {day},
+// {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
+// seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+// are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+// is required. A proto3 JSON serializer should always use UTC (as indicated by
+// "Z") when printing the Timestamp type and a proto3 JSON parser should be
+// able to accept both UTC and other timezones (as indicated by an offset).
+//
+// For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+// 01:30 UTC on January 15, 2017.
+//
+// In JavaScript, one can convert a Date object to this format using the
+// standard
+// [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
+// method. In Python, a standard `datetime.datetime` object can be converted
+// to this format using
+// [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
+// the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
+// the Joda Time's [`ISODateTimeFormat.dateTime()`](
+// http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()
+// ) to obtain a formatter capable of generating timestamps in this format.
+//
+message Timestamp {
+  // Represents seconds of UTC time since Unix epoch
+  // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+  // 9999-12-31T23:59:59Z inclusive.
+  int64 seconds = 1;
+
+  // Non-negative fractions of a second at nanosecond resolution. Negative
+  // second values with fractions must still have non-negative nanos values
+  // that count forward in time. Must be from 0 to 999,999,999
+  // inclusive.
+  int32 nanos = 2;
+}

package/dist/grpc/protos/google/rpc/error_details.proto

@@ -0,0 +1,363 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.rpc;
+
+import "google/protobuf/duration.proto";
+
+option go_package = "google.golang.org/genproto/googleapis/rpc/errdetails;errdetails";
+option java_multiple_files = true;
+option java_outer_classname = "ErrorDetailsProto";
+option java_package = "com.google.rpc";
+option objc_class_prefix = "RPC";
+
+// Describes the cause of the error with structured details.
+//
+// Example of an error when contacting the "pubsub.googleapis.com" API when it
+// is not enabled:
+//
+//     { "reason": "API_DISABLED"
+//       "domain": "googleapis.com"
+//       "metadata": {
+//         "resource": "projects/123",
+//         "service": "pubsub.googleapis.com"
+//       }
+//     }
+//
+// This response indicates that the pubsub.googleapis.com API is not enabled.
+//
+// Example of an error that is returned when attempting to create a Spanner
+// instance in a region that is out of stock:
+//
+//     { "reason": "STOCKOUT"
+//       "domain": "spanner.googleapis.com",
+//       "metadata": {
+//         "availableRegions": "us-central1,us-east2"
+//       }
+//     }
+message ErrorInfo {
+  // The reason of the error. This is a constant value that identifies the
+  // proximate cause of the error. Error reasons are unique within a particular
+  // domain of errors. This should be at most 63 characters and match a
+  // regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents
+  // UPPER_SNAKE_CASE.
+  string reason = 1;
+
+  // The logical grouping to which the "reason" belongs. The error domain
+  // is typically the registered service name of the tool or product that
+  // generates the error. Example: "pubsub.googleapis.com". If the error is
+  // generated by some common infrastructure, the error domain must be a
+  // globally unique value that identifies the infrastructure. For Google API
+  // infrastructure, the error domain is "googleapis.com".
+  string domain = 2;
+
+  // Additional structured details about this error.
+  //
+  // Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should
+  // ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+  // length. When identifying the current value of an exceeded limit, the units
+  // should be contained in the key, not the value.  For example, rather than
+  // `{"instanceLimit": "100/request"}`, should be returned as,
+  // `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+  // instances that can be created in a single (batch) request.
+  map<string, string> metadata = 3;
+}
+
+// Describes when the clients can retry a failed request. Clients could ignore
+// the recommendation here or retry when this information is missing from error
+// responses.
+//
+// It's always recommended that clients should use exponential backoff when
+// retrying.
+//
+// Clients should wait until `retry_delay` amount of time has passed since
+// receiving the error response before retrying.  If retrying requests also
+// fail, clients should use an exponential backoff scheme to gradually increase
+// the delay between retries based on `retry_delay`, until either a maximum
+// number of retries have been reached or a maximum retry delay cap has been
+// reached.
+message RetryInfo {
+  // Clients should wait at least this long between retrying the same request.
+  google.protobuf.Duration retry_delay = 1;
+}
+
+// Describes additional debugging info.
+message DebugInfo {
+  // The stack trace entries indicating where the error occurred.
+  repeated string stack_entries = 1;
+
+  // Additional debugging information provided by the server.
+  string detail = 2;
+}
+
+// Describes how a quota check failed.
+//
+// For example if a daily limit was exceeded for the calling project,
+// a service could respond with a QuotaFailure detail containing the project
+// id and the description of the quota limit that was exceeded.  If the
+// calling project hasn't enabled the service in the developer console, then
+// a service could respond with the project id and set `service_disabled`
+// to true.
+//
+// Also see RetryInfo and Help types for other details about handling a
+// quota failure.
+message QuotaFailure {
+  // A message type used to describe a single quota violation.  For example, a
+  // daily quota or a custom quota that was exceeded.
+  message Violation {
+    // The subject on which the quota check failed.
+    // For example, "clientip:<ip address of client>" or "project:<Google
+    // developer project id>".
+    string subject = 1;
+
+    // A description of how the quota check failed. Clients can use this
+    // description to find more about the quota configuration in the service's
+    // public documentation, or find the relevant quota limit to adjust through
+    // developer console.
+    //
+    // For example: "Service disabled" or "Daily Limit for read operations
+    // exceeded".
+    string description = 2;
+
+    // The API Service from which the `QuotaFailure.Violation` orginates. In
+    // some cases, Quota issues originate from an API Service other than the one
+    // that was called. In other words, a dependency of the called API Service
+    // could be the cause of the `QuotaFailure`, and this field would have the
+    // dependency API service name.
+    //
+    // For example, if the called API is Kubernetes Engine API
+    // (container.googleapis.com), and a quota violation occurs in the
+    // Kubernetes Engine API itself, this field would be
+    // "container.googleapis.com". On the other hand, if the quota violation
+    // occurs when the Kubernetes Engine API creates VMs in the Compute Engine
+    // API (compute.googleapis.com), this field would be
+    // "compute.googleapis.com".
+    string api_service = 3;
+
+    // The metric of the violated quota. A quota metric is a named counter to
+    // measure usage, such as API requests or CPUs. When an activity occurs in a
+    // service, such as Virtual Machine allocation, one or more quota metrics
+    // may be affected.
+    //
+    // For example, "compute.googleapis.com/cpus_per_vm_family",
+    // "storage.googleapis.com/internet_egress_bandwidth".
+    string quota_metric = 4;
+
+    // The id of the violated quota. Also know as "limit name", this is the
+    // unique identifier of a quota in the context of an API service.
+    //
+    // For example, "CPUS-PER-VM-FAMILY-per-project-region".
+    string quota_id = 5;
+
+    // The dimensions of the violated quota. Every non-global quota is enforced
+    // on a set of dimensions. While quota metric defines what to count, the
+    // dimensions specify for what aspects the counter should be increased.
+    //
+    // For example, the quota "CPUs per region per VM family" enforces a limit
+    // on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions
+    // "region" and "vm_family". And if the violation occurred in region
+    // "us-central1" and for VM family "n1", the quota_dimensions would be,
+    //
+    // {
+    //   "region": "us-central1",
+    //   "vm_family": "n1",
+    // }
+    //
+    // When a quota is enforced globally, the quota_dimensions would always be
+    // empty.
+    map<string, string> quota_dimensions = 6;
+
+    // The enforced quota value at the time of the `QuotaFailure`.
+    //
+    // For example, if the enforced quota value at the time of the
+    // `QuotaFailure` on the number of CPUs is "10", then the value of this
+    // field would reflect this quantity.
+    int64 quota_value = 7;
+
+    // The new quota value being rolled out at the time of the violation. At the
+    // completion of the rollout, this value will be enforced in place of
+    // quota_value. If no rollout is in progress at the time of the violation,
+    // this field is not set.
+    //
+    // For example, if at the time of the violation a rollout is in progress
+    // changing the number of CPUs quota from 10 to 20, 20 would be the value of
+    // this field.
+    optional int64 future_quota_value = 8;
+  }
+
+  // Describes all quota violations.
+  repeated Violation violations = 1;
+}
+
+// Describes what preconditions have failed.
+//
+// For example, if an RPC failed because it required the Terms of Service to be
+// acknowledged, it could list the terms of service violation in the
+// PreconditionFailure message.
+message PreconditionFailure {
+  // A message type used to describe a single precondition failure.
+  message Violation {
+    // The type of PreconditionFailure. We recommend using a service-specific
+    // enum type to define the supported precondition violation subjects. For
+    // example, "TOS" for "Terms of Service violation".
+    string type = 1;
+
+    // The subject, relative to the type, that failed.
+    // For example, "google.com/cloud" relative to the "TOS" type would indicate
+    // which terms of service is being referenced.
+    string subject = 2;
+
+    // A description of how the precondition failed. Developers can use this
+    // description to understand how to fix the failure.
+    //
+    // For example: "Terms of service not accepted".
+    string description = 3;
+  }
+
+  // Describes all precondition violations.
+  repeated Violation violations = 1;
+}
+
+// Describes violations in a client request. This error type focuses on the
+// syntactic aspects of the request.
+message BadRequest {
+  // A message type used to describe a single bad request field.
+  message FieldViolation {
+    // A path that leads to a field in the request body. The value will be a
+    // sequence of dot-separated identifiers that identify a protocol buffer
+    // field.
+    //
+    // Consider the following:
+    //
+    //     message CreateContactRequest {
+    //       message EmailAddress {
+    //         enum Type {
+    //           TYPE_UNSPECIFIED = 0;
+    //           HOME = 1;
+    //           WORK = 2;
+    //         }
+    //
+    //         optional string email = 1;
+    //         repeated EmailType type = 2;
+    //       }
+    //
+    //       string full_name = 1;
+    //       repeated EmailAddress email_addresses = 2;
+    //     }
+    //
+    // In this example, in proto `field` could take one of the following values:
+    //
+    // * `full_name` for a violation in the `full_name` value
+    // * `email_addresses[1].email` for a violation in the `email` field of the
+    //   first `email_addresses` message
+    // * `email_addresses[3].type[2]` for a violation in the second `type`
+    //   value in the third `email_addresses` message.
+    //
+    // In JSON, the same values are represented as:
+    //
+    // * `fullName` for a violation in the `fullName` value
+    // * `emailAddresses[1].email` for a violation in the `email` field of the
+    //   first `emailAddresses` message
+    // * `emailAddresses[3].type[2]` for a violation in the second `type`
+    //   value in the third `emailAddresses` message.
+    string field = 1;
+
+    // A description of why the request element is bad.
+    string description = 2;
+
+    // The reason of the field-level error. This is a constant value that
+    // identifies the proximate cause of the field-level error. It should
+    // uniquely identify the type of the FieldViolation within the scope of the
+    // google.rpc.ErrorInfo.domain. This should be at most 63
+    // characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`,
+    // which represents UPPER_SNAKE_CASE.
+    string reason = 3;
+
+    // Provides a localized error message for field-level errors that is safe to
+    // return to the API consumer.
+    LocalizedMessage localized_message = 4;
+  }
+
+  // Describes all violations in a client request.
+  repeated FieldViolation field_violations = 1;
+}
+
+// Contains metadata about the request that clients can attach when filing a bug
+// or providing other forms of feedback.
+message RequestInfo {
+  // An opaque string that should only be interpreted by the service generating
+  // it. For example, it can be used to identify requests in the service's logs.
+  string request_id = 1;
+
+  // Any data that was used to serve this request. For example, an encrypted
+  // stack trace that can be sent back to the service provider for debugging.
+  string serving_data = 2;
+}
+
+// Describes the resource that is being accessed.
+message ResourceInfo {
+  // A name for the type of resource being accessed, e.g. "sql table",
+  // "cloud storage bucket", "file", "Google calendar"; or the type URL
+  // of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".
+  string resource_type = 1;
+
+  // The name of the resource being accessed.  For example, a shared calendar
+  // name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current
+  // error is
+  // [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].
+  string resource_name = 2;
+
+  // The owner of the resource (optional).
+  // For example, "user:<owner email>" or "project:<Google developer project
+  // id>".
+  string owner = 3;
+
+  // Describes what error is encountered when accessing this resource.
+  // For example, updating a cloud project may require the `writer` permission
+  // on the developer console project.
+  string description = 4;
+}
+
+// Provides links to documentation or for performing an out of band action.
+//
+// For example, if a quota check failed with an error indicating the calling
+// project hasn't enabled the accessed service, this can contain a URL pointing
+// directly to the right place in the developer console to flip the bit.
+message Help {
+  // Describes a URL link.
+  message Link {
+    // Describes what the link offers.
+    string description = 1;
+
+    // The URL of the link.
+    string url = 2;
+  }
+
+  // URL(s) pointing to additional information on handling the current error.
+  repeated Link links = 1;
+}
+
+// Provides a localized error message that is safe to return to the user
+// which can be attached to an RPC error.
+message LocalizedMessage {
+  // The locale used following the specification defined at
+  // https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+  // Examples are: "en-US", "fr-CH", "es-MX"
+  string locale = 1;
+
+  // The localized error message in the above locale.
+  string message = 2;
+}

package/dist/grpc/protos/google/rpc/status.proto

@@ -0,0 +1,49 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.rpc;
+
+import "google/protobuf/any.proto";
+
+option cc_enable_arenas = true;
+option go_package = "google.golang.org/genproto/googleapis/rpc/status;status";
+option java_multiple_files = true;
+option java_outer_classname = "StatusProto";
+option java_package = "com.google.rpc";
+option objc_class_prefix = "RPC";
+
+// The `Status` type defines a logical error model that is suitable for
+// different programming environments, including REST APIs and RPC APIs. It is
+// used by [gRPC](https://github.com/grpc). Each `Status` message contains
+// three pieces of data: error code, error message, and error details.
+//
+// You can find out more about this error model and how to work with it in the
+// [API Design Guide](https://cloud.google.com/apis/design/errors).
+message Status {
+  // The status code, which should be an enum value of
+  // [google.rpc.Code][google.rpc.Code].
+  int32 code = 1;
+
+  // A developer-facing error message, which should be in English. Any
+  // user-facing error message should be localized and sent in the
+  // [google.rpc.Status.details][google.rpc.Status.details] field, or localized
+  // by the client.
+  string message = 2;
+
+  // A list of messages that carry the error details.  There is a common set of
+  // message types for APIs to use.
+  repeated google.protobuf.Any details = 3;
+}

package/dist/grpc/protos/sui/rpc/v2beta2/README.md

@@ -0,0 +1,123 @@
+## Overview
+This package defines a number of APIs for interacting with services in the Sui
+ecosystem. Some of the below API semantics and guidelines are inspired by
+[Google's AIPs](https://google.aip.dev/) and apply to all services in this
+package. For information on the individual services themselves, see their
+definitions:
+
+- [`LedgerService`](./ledger_service.proto)
+- [`LiveDataService`](./live_data_service.proto)
+- [`MovePackageService`](./move_package_service.proto.proto)
+- [`SignatureVerificationService`](./signature_verification_service.proto)
+- [`SubscriptionService`](./subscription_service.proto.proto)
+- [`TransactionExecutionService`](./transaction_execution_service.proto.proto)
+
+## Encoding
+In order to improve usability of these APIs a number of identifiers are
+encoding in messages in this package using their human-readable string
+representations instead of a more compact bytes representation.
+
+- `Address` and `ObjectId`: Represented as 64 hexadecimal characters with a
+  leading `0x`.
+- `Digest`s: Represented as
+  [Base58](https://learnmeabitcoin.com/technical/keys/base58/).
+- `TypeTag` and `StructTag`: Represented in their canonical string format (for
+  example,
+  `0x0000000000000000000000000000000000000000000000000000000000000002::coin::Coin<0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI>`)
+
+## Field Masks and Partial Responses
+Some APIs may return resources that are either larger or expensive to compute
+and the API may want to give the user control over which fields it returns.
+
+In such circumstances Field Masks
+[(google.protobuf.FieldMask)](../../../google/protobuf/field_mask.proto) can be
+used for granting the user fine-grained control over what fields are returned.
+
+For APIs where Field Masks are supported:
+
+- The field masks must be a google.protobuf.FieldMask and should be named
+  `read_mask`.
+- The field mask parameter must be optional:
+    - An explicit value of `"*"` should be supported, and must return all
+      fields.
+    - If the field mask parameter is omitted, it must default to `"*"`, unless
+      otherwise documented.
+- An API may allow read masks with non-terminal repeated fields (counter to the
+  documentation on Field Masks).
+
+## Pagination
+Some APIs often need to provide collections of data. However, collections can
+often be arbitrarily sized, and also often grow over time, increasing lookup
+time as well as the size of the responses being sent over the wire. Therefore,
+it is important that such APIs listing over a collection be paginated.
+
+APIs returning collections of data must provide pagination at the outset, as it
+is a backwards-incompatible change to add pagination to an existing method.
+
+- Request messages for collections should define an `uint32 page_size` field,
+  allowing users to specify the maximum number of results to return.
+    - The `page_size` field must not be required.
+    - If the user does not specify `page_size` (or specifies `0`), the API
+      chooses an appropriate default, which the API should document. The API
+      must not return an error.
+    - If the user specifies `page_size` greater than the maximum permitted by
+      the API, the API should coerce down to the maximum permitted page size.
+    - The API may return fewer results than the number requested (including
+      zero results), even if not at the end of the collection.
+- Request messages for collections should define a `bytes page_token` field,
+  allowing users to advance to the next page in the collection.
+    - The `page_token` field must not be required.
+    - If the user changes the `page_size` in a request for subsequent pages,
+      the service must honor the new page size.
+    - The user is expected to keep all other arguments to the RPC the same; if
+      any arguments are different, the API should send an `INVALID_ARGUMENT`
+      error.
+- Response messages for collections should define a `bytes next_page_token`
+  field, providing the user with a page token that may be used to retrieve the
+  next page.
+    - The field containing pagination results should be the first field in the
+      message and have a field number of `1`. It should be a repeated field
+      containing a list of resources constituting a single page of results.
+    - If the end of the collection has been reached, the `next_page_token`
+      field must be empty. This is the only way to communicate
+      "end-of-collection" to users.
+    - If the end of the collection has not been reached (or if the API can not
+      determine in time), the API must provide a `next_page_token`.
+
+## Field Presence
+The proto files used in this package for message and service definitions are
+all defined using protobuf version 3 (`proto3`). In `proto3`, fields that are
+primitives (that is, they are not a `message`) and are not present on the wire
+are zero-initialized. To gain the ability to detect [field
+presence](https://github.com/protocolbuffers/protobuf/blob/main/docs/field_presence.md),
+these definitions follow the convention of having all fields marked `optional`,
+and wrapping `repeated` fields in a message as needed.
+
+## Errors
+The services defined in this package support the [richer error
+model](https://grpc.io/docs/guides/error/#richer-error-model) following [AIP
+193](https://google.aip.dev/193). In particular, when an RPC returns a response
+with a non-OK status code, richer error information can generally be found by
+looking at the `grpc-status-details-bin` header which contains a
+[google.rpc.Status](https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto)
+message encoded in Base64.
+
+## HTTP Headers
+Implementations of the services defined in this package should set the
+following HTTP headers in responses where possible:
+
+- `x-sui-chain-id`: Chain Id of the current chain
+- `x-sui-chain`: Human-readable name of the current chain
+- `x-sui-checkpoint-height`: Current checkpoint height
+- `x-sui-lowest-available-checkpoint`: Lowest available checkpoint for which
+  transaction and checkpoint data can be requested. Specifically this is the
+  lowest checkpoint for which the following data can be requested: checkpoints,
+  transactions, effects and events.
+- `x-sui-lowest-available-checkpoint-objects`: Lowest available checkpoint for
+  which object data can be requested. Specifically this is the lowest
+  checkpoint for which input/output object data will be available.
+- `x-sui-epoch`: Current epoch of the chain.
+- `x-sui-timestamp-ms`: Current timestamp of the chain, represented as number
+  of milliseconds from the Unix epoch.
+- `x-sui-timestamp`: Current timestamp of the chain, encoded in the
+  [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format.