rpc: update docs

MystenLabs · Feb 20, 2025 · 0d0f022 · 0d0f022
1 parent b24b871
commit 0d0f022
Show file tree

Hide file tree

Showing 9 changed files with 4,349 additions and 1,989 deletions.
diff --git a/crates/sui-rpc-api/generate-grpc-docs.sh b/crates/sui-rpc-api/generate-grpc-docs.sh
@@ -9,10 +9,18 @@ SCRIPT_PATH=$(realpath "$0")
 SCRIPT_DIR=$(dirname "$SCRIPT_PATH")
 
 PROTO_FILES=(
-proto/sui.node.v2.proto
-proto/sui.types.proto
+proto/google/protobuf/any.proto
+proto/google/protobuf/duration.proto
 proto/google/protobuf/empty.proto
+proto/google/protobuf/field_mask.proto
 proto/google/protobuf/timestamp.proto
+proto/google/rpc/error_details.proto
+proto/google/rpc/status.proto
+proto/sui/node/v2/node_service.proto
+proto/sui/node/v2alpha/node_service.proto
+proto/sui/node/v2alpha/subscription_service.proto
+proto/sui/types/signature_scheme.proto
+proto/sui/types/types.proto
 )
 
 # requires that protoc as well as the protoc-gen-doc plugin is installed and

diff --git a/crates/sui-rpc-api/proto/documentation.json b/crates/sui-rpc-api/proto/documentation.json
diff --git a/crates/sui-rpc-api/proto/documentation.md b/crates/sui-rpc-api/proto/documentation.md
diff --git a/crates/sui-rpc-api/proto/sui/node/v2/node_service.proto b/crates/sui-rpc-api/proto/sui/node/v2/node_service.proto
@@ -149,40 +149,40 @@ message GetTransactionResponse {
   // The digest of this [Transaction](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.Transaction.html).
   optional sui.types.Digest digest = 1;
 
-  // Optional. The transaction itself.
+  // The transaction itself.
   optional sui.types.Transaction transaction = 2;
 
-  // Optional. The
+  // The
   // [Transaction](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.Transaction.html)
   // encoded as BCS bytes.
   optional sui.types.Bcs transaction_bcs = 3;
 
-  // Optional. List of user signatures that are used to authorize the
+  // List of user signatures that are used to authorize the
   // execution of this transaction.
   repeated sui.types.UserSignature signatures = 4;
 
-  // Optional. List of
+  // List of
   // [UserSignature](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.UserSignature.html)s
   // encoded as bytes.
   repeated bytes signatures_bytes = 11;
 
-  // Optional. The `TransactionEffects` for this transaction.
+  // The `TransactionEffects` for this transaction.
   optional sui.types.TransactionEffects effects = 5;
 
-  // Optional. The
+  // The
   // [TransactionEffects](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.TransactionEffects.html)
   // for this transaction encoded as BCS bytes.
   optional sui.types.Bcs effects_bcs = 6;
 
-  // Optional. The `TransactionEvents` for this transaction.
+  // The `TransactionEvents` for this transaction.
   //
   // This field might be empty, even if it was explicitly requested, if the
   // transaction didn't produce any events.
   // `sui.types.TransactionEffects.events_digest` is populated if the
   // transaction produced any events.
   optional sui.types.TransactionEvents events = 7;
 
-  // Optional. The
+  // The
   // [TransactionEvents](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.TransactionEvents.html)
   // for this transaction encoded as BCS bytes.
   optional sui.types.Bcs events_bcs = 8;
@@ -220,10 +220,10 @@ message GetObjectResponse {
   // The digest of this object.
   optional sui.types.Digest digest = 3;
 
-  // Optional. The object itself.
+  // The object itself.
   optional sui.types.Object object = 4;
 
-  // Optional. The
+  // The
   // [Object](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.Object.html)
   // encoded as BCS bytes.
   optional sui.types.Bcs object_bcs = 5;
@@ -254,22 +254,22 @@ message GetCheckpointResponse {
   // The digest of this checkpoint's `CheckpointSummary`.
   optional sui.types.Digest digest = 2;
 
-  // Optional. The `CheckpointSummary` for this checkpoint.
+  // The `CheckpointSummary` for this checkpoint.
   optional sui.types.CheckpointSummary summary = 3;
 
-  // Optional. The
+  // The
   // [CheckpointSummary](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.CheckpointSummary.html)
   // for this checkpoint encoded as BCS bytes.
   optional sui.types.Bcs summary_bcs = 4;
 
-  // Optional. An aggregated quorum signature from the validator committee that
+  // An aggregated quorum signature from the validator committee that
   // certifies this checkpoint.
   optional sui.types.ValidatorAggregatedSignature signature = 5;
 
-  // Optional. The `CheckpointContents` for this checkpoint.
+  // The `CheckpointContents` for this checkpoint.
   optional sui.types.CheckpointContents contents = 6;
 
-  // Optional. The
+  // The
   // [CheckpointContents](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.CheckpointContents.html)
   // for this checkpoint encoded as BCS bytes.
   optional sui.types.Bcs contents_bcs = 7;
@@ -299,22 +299,22 @@ message GetFullCheckpointResponse {
   // The digest of this checkpoint's `CheckpointSummary`.
   optional sui.types.Digest digest = 2;
 
-  // Optional. The `CheckpointSummary` for this checkpoint.
+  // The `CheckpointSummary` for this checkpoint.
   optional sui.types.CheckpointSummary summary = 3;
 
-  // Optional. The
+  // The
   // [CheckpointSummary](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.CheckpointSummary.html)
   // for this checkpoint encoded as BCS bytes.
   optional sui.types.Bcs summary_bcs = 4;
 
-  // Optional. An aggregated quorum signature from the validator committee that
+  // An aggregated quorum signature from the validator committee that
   // certifies this checkpoint.
   optional sui.types.ValidatorAggregatedSignature signature = 5;
 
-  // Optional. The `CheckpointContents` for this checkpoint.
+  // The `CheckpointContents` for this checkpoint.
   optional sui.types.CheckpointContents contents = 6;
 
-  // Optional. The
+  // The
   // [CheckpointContents](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.CheckpointContents.html)
   // for this checkpoint encoded as BCS bytes.
   optional sui.types.Bcs contents_bcs = 7;
@@ -328,39 +328,39 @@ message FullCheckpointTransaction {
   // The digest of this transaction.
   optional sui.types.Digest digest = 1;
 
-  // Optional. The transaction itself.
+  // The transaction itself.
   optional sui.types.Transaction transaction = 2;
 
-  // Optional. The
+  // The
   // [Transaction](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.Transaction.html)
   // encoded as BCS bytes.
   optional sui.types.Bcs transaction_bcs = 3;
 
-  // Optional. The `TransactionEffects` for this transaction.
+  // The `TransactionEffects` for this transaction.
   optional sui.types.TransactionEffects effects = 5;
 
-  // Optional. The
+  // The
   // [TransactionEffects](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.TransactionEffects.html)
   // for this transaction encoded as BCS bytes.
   optional sui.types.Bcs effects_bcs = 6;
 
-  // Optional. The `TransactionEvents` for this transaction.
+  // The `TransactionEvents` for this transaction.
   //
   // This field might be empty, even if it was explicitly requested, if the
   // transaction didn't produce any events.
   // `sui.types.TransactionEffects.events_digest` is populated if the
   // transaction produced any events.
   optional sui.types.TransactionEvents events = 7;
 
-  // Optional. The
+  // The
   // [TransactionEvents](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.TransactionEvents.html)
   // for this transaction encoded as BCS bytes.
   optional sui.types.Bcs events_bcs = 8;
 
-  // Optional. Set of input objects used during the execution of this transaction.
+  // Set of input objects used during the execution of this transaction.
   repeated FullCheckpointObject input_objects = 13;
 
-  // Optional. Set of output objects produced from the execution of this transaction.
+  // Set of output objects produced from the execution of this transaction.
   repeated FullCheckpointObject output_objects = 14;
 }
 
@@ -375,10 +375,10 @@ message FullCheckpointObject {
   // The digest of this object.
   optional sui.types.Digest digest = 3;
 
-  // Optional. The object itself.
+  // The object itself.
   optional sui.types.Object object = 4;
 
-  // Optional. The
+  // The
   // [object](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.Object.html)
   // encoded as BCS bytes.
   optional sui.types.Bcs object_bcs = 5;
@@ -412,28 +412,28 @@ message ExecuteTransactionResponse {
   // Indicates the finality of the executed transaction.
   optional EffectsFinality finality = 1;
 
-  // Optional. The `TransactionEffects` for this transaction.
+  // The `TransactionEffects` for this transaction.
   optional sui.types.TransactionEffects effects = 2;
 
-  // Optional. The
+  // The
   // [TransactionEffects](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.TransactionEffects.html)
   // for this transaction encoded as BCS bytes.
   optional sui.types.Bcs effects_bcs = 3;
 
-  // Optional. The `TransactionEvents` for this transaction.
+  // The `TransactionEvents` for this transaction.
   //
   // This field might be empty, even if it was explicitly requested, if the
   // transaction didn't produce any events.
   // `sui.types.TransactionEffects.events_digest` is populated if the
   // transaction produced any events.
   optional sui.types.TransactionEvents events = 4;
 
-  // Optional. The
+  // The
   // [TransactionEvents](https://docs.rs/sui-sdk-types/latest/sui_sdk_types/struct.TransactionEvents.html)
   // for this transaction encoded as BCS bytes.
   optional sui.types.Bcs events_bcs = 5;
 
-  // Optional. Set of balance change events as a result of this transaction.
+  // Set of balance change events as a result of this transaction.
   //
   // This set of events are calculated by analyzing all input and output `Coin`
   // type objects.

diff --git a/crates/sui-rpc-api/proto/sui/node/v2alpha/node_service.proto b/crates/sui-rpc-api/proto/sui/node/v2alpha/node_service.proto
@@ -41,16 +41,16 @@ message GetCoinInfoResponse {
   // Required. The coin type.
   optional sui.types.TypeTag coin_type = 1;
 
-  // Optional. This field will be populated with information about this coin
+  // This field will be populated with information about this coin
   // type's `0x2::coin::CoinMetadata` if it exists and has not been wrapped.
   optional CoinMetadata metadata = 2;
 
-  // Optional. This field will be populated with information about this coin
+  // This field will be populated with information about this coin
   // type's `0x2::coin::TreasuryCap` if it exists and has not been wrapped.
   optional CoinTreasury treasury = 3;
 
   // TODO add support for tracking RegulatedCoinMetadata
-  // Optional. If this coin type is a regulated coin, this field will be
+  // If this coin type is a regulated coin, this field will be
   // populated with information about its `0x2::coin::RegulatedCoinMetadata`
   // object.
   // optional RegulatedCoinMetadata regulated_metadata = 4;
@@ -131,7 +131,7 @@ message DynamicField {
   // Required. The serialized move value of "name"
   optional bytes name_value = 4;
 
-  // Optional. The ObjectId of the child object when a child is a dynamic
+  // The ObjectId of the child object when a child is a dynamic
   // object field.
   //
   // The presence or absence of this field can be used to determine if a child