feat(graphql): add MissingRootObject error for DF queries

AftermathFinance · Jun 9, 2024 · 8cbe505 · 8cbe505
1 parent 5afe7a4
commit 8cbe505
Show file tree

Hide file tree

Showing 7 changed files with 82 additions and 18 deletions.
diff --git a/crates/sui-graphql-rpc/src/error.rs b/crates/sui-graphql-rpc/src/error.rs
@@ -71,6 +71,13 @@ pub enum Error {
     CursorNoFirstLast,
     #[error("Connection's page size of {0} exceeds max of {1}")]
     PageTooLarge(u64, u64),
+    #[error(
+        "To get the dynamic field(s) of an IObject, the query must be rooted in a non-child object,\
+        i.e, a shared or an owned object, so that its version can be used to bound the DFs' \
+        versions. To get the dynamic fields of an address at the latest checkpoint, use the \
+        Query.owner field instead."
+    )]
+    MissingRootObject,
     // Catch-all for client-fault errors
     #[error("{0}")]
     Client(String),
@@ -85,6 +92,7 @@ impl ErrorExtensions for Error {
             | Error::CursorNoFirstLast
             | Error::PageTooLarge(_, _)
             | Error::ProtocolVersionUnsupported(_, _)
+            | Error::MissingRootObject
             | Error::Client(_) => {
                 e.set("code", code::BAD_USER_INPUT);
             }

diff --git a/crates/sui-graphql-rpc/src/types/coin.rs b/crates/sui-graphql-rpc/src/types/coin.rs
@@ -244,7 +244,7 @@ impl Coin {
         name: DynamicFieldName,
     ) -> Result<Option<DynamicField>> {
         OwnerImpl::from(&self.super_.super_)
-            .dynamic_field(ctx, name, self.super_.root_version())
+            .dynamic_field(ctx, name, Some(self.super_.get_root_version()?))
             .await
     }
 
@@ -261,7 +261,7 @@ impl Coin {
         name: DynamicFieldName,
     ) -> Result<Option<DynamicField>> {
         OwnerImpl::from(&self.super_.super_)
-            .dynamic_object_field(ctx, name, self.super_.root_version())
+            .dynamic_object_field(ctx, name, Some(self.super_.get_root_version()?))
             .await
     }
 
@@ -278,7 +278,14 @@ impl Coin {
         before: Option<object::Cursor>,
     ) -> Result<Connection<String, DynamicField>> {
         OwnerImpl::from(&self.super_.super_)
-            .dynamic_fields(ctx, first, after, last, before, self.super_.root_version())
+            .dynamic_fields(
+                ctx,
+                first,
+                after,
+                last,
+                before,
+                Some(self.super_.get_root_version()?),
+            )
             .await
     }
 

diff --git a/crates/sui-graphql-rpc/src/types/coin_metadata.rs b/crates/sui-graphql-rpc/src/types/coin_metadata.rs
@@ -233,7 +233,7 @@ impl CoinMetadata {
         name: DynamicFieldName,
     ) -> Result<Option<DynamicField>> {
         OwnerImpl::from(&self.super_.super_)
-            .dynamic_field(ctx, name, self.super_.root_version())
+            .dynamic_field(ctx, name, Some(self.super_.get_root_version()?))
             .await
     }
 
@@ -250,7 +250,7 @@ impl CoinMetadata {
         name: DynamicFieldName,
     ) -> Result<Option<DynamicField>> {
         OwnerImpl::from(&self.super_.super_)
-            .dynamic_object_field(ctx, name, self.super_.root_version())
+            .dynamic_object_field(ctx, name, Some(self.super_.get_root_version()?))
             .await
     }
 
@@ -267,7 +267,14 @@ impl CoinMetadata {
         before: Option<object::Cursor>,
     ) -> Result<Connection<String, DynamicField>> {
         OwnerImpl::from(&self.super_.super_)
-            .dynamic_fields(ctx, first, after, last, before, self.super_.root_version())
+            .dynamic_fields(
+                ctx,
+                first,
+                after,
+                last,
+                before,
+                Some(self.super_.get_root_version()?),
+            )
             .await
     }
 

diff --git a/crates/sui-graphql-rpc/src/types/move_object.rs b/crates/sui-graphql-rpc/src/types/move_object.rs
@@ -312,7 +312,7 @@ impl MoveObject {
         name: DynamicFieldName,
     ) -> Result<Option<DynamicField>> {
         OwnerImpl::from(&self.super_)
-            .dynamic_field(ctx, name, self.root_version())
+            .dynamic_field(ctx, name, Some(self.get_root_version()?))
             .await
     }
 
@@ -329,7 +329,7 @@ impl MoveObject {
         name: DynamicFieldName,
     ) -> Result<Option<DynamicField>> {
         OwnerImpl::from(&self.super_)
-            .dynamic_object_field(ctx, name, self.root_version())
+            .dynamic_object_field(ctx, name, Some(self.get_root_version()?))
             .await
     }
 
@@ -346,7 +346,14 @@ impl MoveObject {
         before: Option<object::Cursor>,
     ) -> Result<Connection<String, DynamicField>> {
         OwnerImpl::from(&self.super_)
-            .dynamic_fields(ctx, first, after, last, before, self.root_version())
+            .dynamic_fields(
+                ctx,
+                first,
+                after,
+                last,
+                before,
+                Some(self.get_root_version()?),
+            )
             .await
     }
 
@@ -462,6 +469,13 @@ impl MoveObject {
     pub(crate) fn root_version(&self) -> Option<u64> {
         self.super_.root_version()
     }
+
+    /// Require this object's root parent object version for dynamic field queries.
+    ///
+    /// Fails with an error if the query was rooted in a child object.
+    pub(crate) fn get_root_version(&self) -> Result<u64, Error> {
+        self.super_.get_root_version()
+    }
 }
 
 impl TryFrom<&Object> for MoveObject {

diff --git a/crates/sui-graphql-rpc/src/types/object.rs b/crates/sui-graphql-rpc/src/types/object.rs
@@ -474,7 +474,7 @@ impl Object {
         name: DynamicFieldName,
     ) -> Result<Option<DynamicField>> {
         OwnerImpl::from(self)
-            .dynamic_field(ctx, name, self.root_version())
+            .dynamic_field(ctx, name, Some(self.get_root_version()?))
             .await
     }
 
@@ -491,7 +491,7 @@ impl Object {
         name: DynamicFieldName,
     ) -> Result<Option<DynamicField>> {
         OwnerImpl::from(self)
-            .dynamic_object_field(ctx, name, self.root_version())
+            .dynamic_object_field(ctx, name, Some(self.get_root_version()?))
             .await
     }
 
@@ -508,7 +508,14 @@ impl Object {
         before: Option<Cursor>,
     ) -> Result<Connection<String, DynamicField>> {
         OwnerImpl::from(self)
-            .dynamic_fields(ctx, first, after, last, before, self.root_version())
+            .dynamic_fields(
+                ctx,
+                first,
+                after,
+                last,
+                before,
+                Some(self.get_root_version()?),
+            )
             .await
     }
 
@@ -729,6 +736,13 @@ impl Object {
         self.root_version
     }
 
+    /// Require this object's root parent object version for dynamic field queries.
+    ///
+    /// Fails with an error if the query was rooted in a child object.
+    pub(crate) fn get_root_version(&self) -> Result<u64, Error> {
+        self.root_version.ok_or(Error::MissingRootObject)
+    }
+
     /// Query the database for a `page` of objects, optionally `filter`-ed.
     ///
     /// `checkpoint_viewed_at` represents the checkpoint sequence number at which this page was

diff --git a/crates/sui-graphql-rpc/src/types/stake.rs b/crates/sui-graphql-rpc/src/types/stake.rs
@@ -252,7 +252,7 @@ impl StakedSui {
         name: DynamicFieldName,
     ) -> Result<Option<DynamicField>> {
         OwnerImpl::from(&self.super_.super_)
-            .dynamic_field(ctx, name, self.super_.root_version())
+            .dynamic_field(ctx, name, Some(self.super_.get_root_version()?))
             .await
     }
 
@@ -269,7 +269,7 @@ impl StakedSui {
         name: DynamicFieldName,
     ) -> Result<Option<DynamicField>> {
         OwnerImpl::from(&self.super_.super_)
-            .dynamic_object_field(ctx, name, self.super_.root_version())
+            .dynamic_object_field(ctx, name, Some(self.super_.get_root_version()?))
             .await
     }
 
@@ -286,7 +286,14 @@ impl StakedSui {
         before: Option<object::Cursor>,
     ) -> Result<Connection<String, DynamicField>> {
         OwnerImpl::from(&self.super_.super_)
-            .dynamic_fields(ctx, first, after, last, before, self.super_.root_version())
+            .dynamic_fields(
+                ctx,
+                first,
+                after,
+                last,
+                before,
+                Some(self.super_.get_root_version()?),
+            )
             .await
     }
 

diff --git a/crates/sui-graphql-rpc/src/types/suins_registration.rs b/crates/sui-graphql-rpc/src/types/suins_registration.rs
@@ -289,7 +289,7 @@ impl SuinsRegistration {
         name: DynamicFieldName,
     ) -> Result<Option<DynamicField>> {
         OwnerImpl::from(&self.super_.super_)
-            .dynamic_field(ctx, name, self.super_.root_version())
+            .dynamic_field(ctx, name, Some(self.super_.get_root_version()?))
             .await
     }
 
@@ -306,7 +306,7 @@ impl SuinsRegistration {
         name: DynamicFieldName,
     ) -> Result<Option<DynamicField>> {
         OwnerImpl::from(&self.super_.super_)
-            .dynamic_object_field(ctx, name, self.super_.root_version())
+            .dynamic_object_field(ctx, name, Some(self.super_.get_root_version()?))
             .await
     }
 
@@ -323,7 +323,14 @@ impl SuinsRegistration {
         before: Option<object::Cursor>,
     ) -> Result<Connection<String, DynamicField>> {
         OwnerImpl::from(&self.super_.super_)
-            .dynamic_fields(ctx, first, after, last, before, self.super_.root_version())
+            .dynamic_fields(
+                ctx,
+                first,
+                after,
+                last,
+                before,
+                Some(self.super_.get_root_version()?),
+            )
             .await
     }