[RPC Server] Simplify the response schema for object_info (#1440)

sui/src/rest_gateway/responses.rs

@@ -19,7 +19,9 @@ use serde_with::serde_as;
 
 use sui_types::base_types::{ObjectDigest, ObjectID, ObjectRef, SequenceNumber};
 use sui_types::crypto::SignableBytes;
+use sui_types::error::SuiError;
 use sui_types::messages::TransactionData;
+use sui_types::object::ObjectRead;
 
 #[serde_as]
 #[derive(Serialize, Deserialize, JsonSchema)]
@@ -39,14 +41,6 @@ pub struct NamedObjectRef {
 }
 
 impl NamedObjectRef {
-    pub fn from((object_id, version, digest): ObjectRef) -> Self {
-        Self {
-            object_id: object_id.to_hex(),
-            version: version.value(),
-            digest: Base64::encode_string(digest.as_ref()),
-        }
-    }
-
     pub fn to_object_ref(self) -> Result<ObjectRef, anyhow::Error> {
         Ok((
             ObjectID::try_from(self.object_id)?,
@@ -56,6 +50,16 @@ impl NamedObjectRef {
     }
 }
 
+impl From<ObjectRef> for NamedObjectRef {
+    fn from((object_id, version, digest): ObjectRef) -> Self {
+        Self {
+            object_id: object_id.to_hex(),
+            version: version.value(),
+            digest: Base64::encode_string(digest.as_ref()),
+        }
+    }
+}
+
 #[derive(Serialize, Deserialize)]
 #[serde(rename_all = "camelCase", transparent)]
 pub struct JsonResponse<T>(pub T);
@@ -132,3 +136,44 @@ impl<T: JsonSchema + Serialize + Send + Sync + 'static> HttpResponse for HttpRes
         dropshot::HttpResponseOk::<T>::metadata()
     }
 }
+
+#[derive(Serialize, Deserialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
+pub struct ObjectExistsResponse {
+    object_ref: NamedObjectRef,
+    object: Value,
+}
+
+#[derive(Serialize, Deserialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
+pub struct ObjectNotExistsResponse {
+    object_id: String,
+}
+
+#[allow(clippy::large_enum_variant)]
+#[derive(Serialize, Deserialize, JsonSchema)]
+#[serde(tag = "status", content = "details")]
+pub enum GetObjectInfoResponse {
+    Exists(ObjectExistsResponse),
+    NotExists(ObjectNotExistsResponse),
+    Deleted(NamedObjectRef),
+}
+
+impl TryFrom<ObjectRead> for GetObjectInfoResponse {
+    type Error = SuiError;
+
+    fn try_from(obj: ObjectRead) -> Result<Self, Self::Error> {
+        match obj {
+            ObjectRead::Exists(object_ref, object, layout) => {
+                Ok(Self::Exists(ObjectExistsResponse {
+                    object_ref: object_ref.into(),
+                    object: object.to_json(&layout)?,
+                }))
+            }
+            ObjectRead::NotExists(object_id) => Ok(Self::NotExists(ObjectNotExistsResponse {
+                object_id: object_id.to_hex(),
+            })),
+            ObjectRead::Deleted(obj_ref) => Ok(Self::Deleted(obj_ref.into())),
+        }
+    }
+}

sui/src/rpc_gateway.rs

@@ -27,12 +27,13 @@ use sui_types::object::ObjectRead;
 
 use crate::config::PersistedConfig;
 use crate::gateway::GatewayConfig;
+use crate::rest_gateway::responses::GetObjectInfoResponse;
 use crate::rest_gateway::responses::{NamedObjectRef, ObjectResponse};
 
 #[rpc(server, client, namespace = "sui")]
 pub trait RpcGateway {
-    #[method(name = "getObjectInfo")]
-    async fn get_object_info(&self, object_id: ObjectID) -> RpcResult<ObjectRead>;
+    #[method(name = "getObjectTypedInfo")]
+    async fn get_object_typed_info(&self, object_id: ObjectID) -> RpcResult<GetObjectInfoResponse>;
 
     #[method(name = "transferCoin")]
     async fn transfer_coin(
@@ -118,6 +119,11 @@ pub trait RpcGateway {
 
     #[method(name = "getTransaction")]
     async fn get_transaction(&self, digest: TransactionDigest) -> RpcResult<CertifiedTransaction>;
+
+    /// Low level API to get object info. Client Applications should prefer to use
+    /// `get_object_typed_info` instead.
+    #[method(name = "getObjectInfoRaw")]
+    async fn get_object_info(&self, object_id: ObjectID) -> RpcResult<ObjectRead>;
 }
 
 pub struct RpcGatewayImpl {
@@ -248,6 +254,15 @@ impl RpcGatewayServer for RpcGatewayImpl {
         Ok(self.gateway.get_object_info(object_id).await?)
     }
 
+    async fn get_object_typed_info(&self, object_id: ObjectID) -> RpcResult<GetObjectInfoResponse> {
+        Ok(self
+            .gateway
+            .get_object_info(object_id)
+            .await?
+            .try_into()
+            .map_err(|e| anyhow!("{}", e))?)
+    }
+
     async fn execute_transaction(
         &self,
         signed_tx: SignedTransaction,