grpc: add support for rendering move objects as json

Author: bmwill

crates/sui-e2e-tests/tests/rpc/ledger_service/get_object.rs

@@ -37,6 +37,7 @@ async fn get_object() {
         linkage_table,
         previous_transaction,
         storage_rebate,
+        json,
     } = client
         .get_object(GetObjectRequest {
             object_id: Some(id.to_string()),
@@ -63,6 +64,7 @@ async fn get_object() {
     assert!(linkage_table.is_empty());
     assert!(previous_transaction.is_none());
     assert!(storage_rebate.is_none());
+    assert!(json.is_none());
 
     // Request with provided read_mask
     let Object {
@@ -79,6 +81,7 @@ async fn get_object() {
         linkage_table,
         previous_transaction,
         storage_rebate,
+        json,
     } = client
         .get_object(GetObjectRequest {
             object_id: Some(id.to_string()),
@@ -104,6 +107,7 @@ async fn get_object() {
     assert!(linkage_table.is_empty());
     assert!(previous_transaction.is_none());
     assert!(storage_rebate.is_none());
+    assert!(json.is_none());
 
     let response = client
         .get_object(GetObjectRequest {
@@ -114,6 +118,7 @@ async fn get_object() {
                 "version",
                 "digest",
                 "bcs",
+                "json",
             ])),
         })
         .await
@@ -134,6 +139,7 @@ async fn get_object() {
         linkage_table,
         previous_transaction,
         storage_rebate,
+        json,
     } = &response;
 
     assert!(object_id.is_some());
@@ -150,6 +156,7 @@ async fn get_object() {
     assert!(linkage_table.is_empty());
     assert!(previous_transaction.is_none());
     assert!(storage_rebate.is_none());
+    assert!(json.is_some());
 }
 
 #[sim_test]

crates/sui-rpc-api/proto/sui/rpc/v2beta/object.proto

@@ -5,6 +5,7 @@ syntax = "proto3";
 
 package sui.rpc.v2beta;
 
+import "google/protobuf/struct.proto";
 import "sui/rpc/v2beta/bcs.proto";
 import "sui/rpc/v2beta/owner.proto";
 
@@ -65,6 +66,9 @@ message Object {
   // This number is re-calculated each time the object is mutated based on
   // the present storage gas price.
   optional uint64 storage_rebate = 13;
+
+  // JSON rendering of the object.
+  optional google.protobuf.Value json = 100;
 }
 
 // Module defined by a package.

crates/sui-rpc-api/src/grpc/v2beta/ledger_service/get_object.rs

@@ -3,11 +3,12 @@
 
 use prost_types::FieldMask;
 use sui_sdk_types::ObjectId;
+use sui_types::sui_sdk_types_conversions::struct_tag_sdk_to_core;
 
 use crate::error::ObjectNotFoundError;
 use crate::field_mask::FieldMaskTree;
 use crate::field_mask::FieldMaskUtil;
-use crate::message::MessageMergeFrom;
+use crate::message::MessageMerge;
 use crate::proto::google::rpc::bad_request::FieldViolation;
 use crate::proto::rpc::v2beta::BatchGetObjectsRequest;
 use crate::proto::rpc::v2beta::BatchGetObjectsResponse;
@@ -113,5 +114,31 @@ fn get_object_impl(
             .ok_or_else(|| ObjectNotFoundError::new(object_id))?
     };
 
-    Ok(Object::merge_from(object, read_mask))
+    let mut message = Object::default();
+
+    if read_mask.contains(Object::JSON_FIELD.name) {
+        message.json = object
+            .as_struct()
+            .and_then(|s| {
+                let struct_tag = struct_tag_sdk_to_core(s.object_type().to_owned()).ok()?;
+                let layout = service
+                    .reader
+                    .inner()
+                    .get_struct_layout(&struct_tag)
+                    .ok()
+                    .flatten()?;
+                Some((layout, s.contents()))
+            })
+            .and_then(|(layout, contents)| {
+                sui_types::proto_value::ProtoVisitor::default()
+                    .deserialize_value(contents, &layout)
+                    .map_err(|e| tracing::debug!("unable to convert to JSON: {e}"))
+                    .ok()
+                    .map(Box::new)
+            });
+    }
+
+    message.merge(object, read_mask);
+
+    Ok(message)
 }

crates/sui-rpc-api/src/proto/generated/sui.rpc.v2beta.fds.bin

@@ -2269,6 +2269,9 @@ pub struct Object {
     /// the present storage gas price.
     #[prost(uint64, optional, tag = "13")]
     pub storage_rebate: ::core::option::Option<u64>,
+    /// JSON rendering of the object.
+    #[prost(message, optional, boxed, tag = "100")]
+    pub json: ::core::option::Option<::prost::alloc::boxed::Box<::prost_types::Value>>,
 }
 /// Module defined by a package.
 #[derive(Clone, PartialEq, ::prost::Message)]

crates/sui-rpc-api/src/proto/generated/sui.rpc.v2beta.rs

@@ -30,6 +30,7 @@ impl Object {
     pub const PREVIOUS_TRANSACTION_FIELD: &'static MessageField =
         &MessageField::new("previous_transaction");
     pub const STORAGE_REBATE_FIELD: &'static MessageField = &MessageField::new("storage_rebate");
+    pub const JSON_FIELD: &'static MessageField = &MessageField::new("json");
 }
 
 impl MessageFields for Object {
@@ -47,6 +48,7 @@ impl MessageFields for Object {
         Self::LINKAGE_TABLE_FIELD,
         Self::PREVIOUS_TRANSACTION_FIELD,
         Self::STORAGE_REBATE_FIELD,
+        Self::JSON_FIELD,
     ];
 }
 
@@ -74,6 +76,7 @@ impl MessageMerge<&Object> for Object {
             linkage_table,
             previous_transaction,
             storage_rebate,
+            json,
         } = source;
 
         if mask.contains(Self::BCS_FIELD.name) {
@@ -127,6 +130,10 @@ impl MessageMerge<&Object> for Object {
         if mask.contains(Self::LINKAGE_TABLE_FIELD.name) {
             self.linkage_table = linkage_table.clone();
         }
+
+        if mask.contains(Self::JSON_FIELD.name) {
+            self.json = json.clone();
+        }
     }
 }
 

crates/sui-rpc-api/src/proto/rpc/v2beta/object.rs

@@ -50,6 +50,7 @@ fn bootstrap() {
         .bytes(["."])
         .btree_map([".sui.node.v2alpha.GetProtocolConfigResponse"])
         .boxed(".sui.rpc.v2beta.Input.literal")
+        .boxed("json")
         .out_dir(&out_dir)
         .compile_fds(fds.clone())
     {