[GraphQL/TransactionBlock] ObjectChange Representation (MystenLabs#15074

) ## Description Bring `ObjectChange` representation inline with `BalanceChange`, `TransactionBlockEffects` etc. In particular objects are not loaded unless explicitly requested. This change also changes the `idCreated` and `idDeleted` fields to always produce a value. They are marked as optional to give us flexibility to change the schema in the future, not because they would otherwise ever be `None`. NB. I'm anticipating a follow-up change to not rely on the indexed object change at all, and instead derive this data from effects, by augmenting `TransactionEffectsAPI` to calculate this for us from raw effects. ## Test Plan ``` sui-graphql-rpc$ cargo nextest run sui-graphql-e2e-tests$ cargo nextest run -j 1 --features pg_integration ``` ## Stack - MystenLabs#14929 - MystenLabs#14930 - MystenLabs#14934 - MystenLabs#14935 - MystenLabs#14961 - MystenLabs#14974 - MystenLabs#15013 - MystenLabs#15014 - MystenLabs#15015 - MystenLabs#15016 - MystenLabs#15018 - MystenLabs#15020 - MystenLabs#15021 - MystenLabs#15036 - MystenLabs#15037 - MystenLabs#15038 - MystenLabs#15039 - MystenLabs#15040 - MystenLabs#15041 - MystenLabs#15042 - MystenLabs#15043 - MystenLabs#15044
ronny-mysten · Dec 1, 2023 · a87c153 · a87c153
1 parent 9c4e8fb
commit a87c153
Show file tree

Hide file tree

Showing 7 changed files with 158 additions and 153 deletions.
diff --git a/crates/sui-graphql-e2e-tests/tests/transactions/programmable.exp b/crates/sui-graphql-e2e-tests/tests/transactions/programmable.exp
@@ -66,24 +66,24 @@ Response: {
             ],
             "objectChanges": [
               {
-                "idCreated": null,
-                "idDeleted": null,
+                "idCreated": false,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x11c5cd8906fc48629f168f5a13a75c8ca77f69ae1ec15edfda29789f1d9638d9",
                   "digest": "9dppxTwUWhC8nVH4Djdv71K75Ze4HEXe5ZU3NcX3TrK"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0xa4a7220856bab19ccaa904d168baa3d733b59c8c067cdcc300502ac352f679af",
                   "digest": "9AR9zGFB4aPcZzniVTVqRTYHwUASw5PXPYsTtomT8jyB"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0xcadb6deed476a072959bd1a031809d737240ccde7917495e16aa9793d6419a74",
                   "digest": "PaCSXQ5RCkt2vc6w2NfZMNBvoCYyM9H6uJJtx1KgEyj"
@@ -185,24 +185,24 @@ Response: {
             ],
             "objectChanges": [
               {
-                "idCreated": null,
-                "idDeleted": null,
+                "idCreated": false,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x11c5cd8906fc48629f168f5a13a75c8ca77f69ae1ec15edfda29789f1d9638d9",
                   "digest": "765g4rih8tpnzb9gHEHArtZ3Ye7SJ3CJUapLVUsdcd6K"
                 }
               },
               {
-                "idCreated": null,
-                "idDeleted": null,
+                "idCreated": false,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0xa4a7220856bab19ccaa904d168baa3d733b59c8c067cdcc300502ac352f679af",
                   "digest": "Hyz4RaTV3cApJs911rX9CURmBd7amvComK4hoNrX7Dmg"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x260de89d19ced9a26b7efba21d133f71987aa80696228f1dee6178961d0e07be",
                   "digest": "9jMyF1w9TTRgvXdsWAn8d5awmQXYD4gUe1qX586UwWVt"
@@ -301,8 +301,8 @@ Response: {
             ],
             "objectChanges": [
               {
-                "idCreated": null,
-                "idDeleted": null,
+                "idCreated": false,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x11c5cd8906fc48629f168f5a13a75c8ca77f69ae1ec15edfda29789f1d9638d9",
                   "digest": "6bbvaLxYq6Fj8bVvhvKkeZM3u27ecvwe9hGkbdsSXd2e",
@@ -323,7 +323,7 @@ Response: {
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x505c5f4993a1fe74c5492945104578ca55d6275a15d64ecc21de6b7b5ef34804",
                   "digest": "5ayrZbSq44X3WqnwNsVvNHGs21YntWobKUoFZQbvVMyw",
@@ -345,7 +345,7 @@ Response: {
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x82ff2affd2e0447baea51fb07098dd4192c38424f41e291c7b47bcae5be0f37c",
                   "digest": "choJQNN7TWytitxF59W6QgnECZkzL28oT77TSkLvox7",
@@ -456,8 +456,8 @@ Response: {
             ],
             "objectChanges": [
               {
-                "idCreated": null,
-                "idDeleted": null,
+                "idCreated": false,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x11c5cd8906fc48629f168f5a13a75c8ca77f69ae1ec15edfda29789f1d9638d9",
                   "digest": "EW31fn6wtJxosHoPLnhPNp8tNQgCctYMksKDMY6St4y5"

diff --git a/crates/sui-graphql-e2e-tests/tests/transactions/system.exp b/crates/sui-graphql-e2e-tests/tests/transactions/system.exp
@@ -74,127 +74,127 @@ Response: {
             "objectChanges": [
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x0000000000000000000000000000000000000000000000000000000000000001",
                   "digest": "FvLv2TuVhx1Ga8oCLW4gZmiBnQpT7XkSdGBo753kApGD"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x0000000000000000000000000000000000000000000000000000000000000002",
                   "digest": "CcD7UEtUeyPhcnqdxS5GFRTQ9xRsx71wZ3fRcGsaKEUp"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x0000000000000000000000000000000000000000000000000000000000000003",
                   "digest": "4VXaAMUGRedbhHDoNifrFx2iYeC8n5qB1W6BDsUvJc3h"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x0000000000000000000000000000000000000000000000000000000000000005",
                   "digest": "EVK8EKnUhpqHEGHYX8da98qWhQT965WLxanbCZnwaT1Y"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x0000000000000000000000000000000000000000000000000000000000000006",
                   "digest": "D1mkJGFbzAZmXfD3ktF38Endz9LtnML94B5kuyQEhR1e"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x0000000000000000000000000000000000000000000000000000000000000007",
                   "digest": "2aRjNBbkQWJToXLL74Wzv2GDu9sWcFPd5XXgvrgk7FAC"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x000000000000000000000000000000000000000000000000000000000000dee9",
                   "digest": "FX5F5Ex6asvjDd5xU8VBua8eSGp9YAh7rBse6LJsxwBa"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x14498a4368db5cefb6ec2fe91cf18636c5d8fc08b91e3d1417ccb0866e8b95d4",
                   "digest": "94HmeZ5AZqsm4X4HStQEkJqiuQWQWogMRepMzHNcfXVS"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x168e8bf1317ef81399ea9fabee9e217067a257731903b45ca4915c8d049b3940",
                   "digest": "8qJceXqDUSngLbk1rpquzALgcT4WtKfhM78LXepgZmtf"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x1ca7fcc2fe39d93fd041dbcbcc30b33a366b44cab26acd52e5d99f6cf2a0a6e7",
                   "digest": "5ZKMLAipLWCy8rkKBWVbf3NVbdEtna81wwNvt37PVdhj"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x3fa556a7dadc08367a52a6eb4a3b602abbc21446c1f703d2ac46866a403d718e",
                   "digest": "BUFgjXdbMvsknRVvLDefPKCzir7EPpkPmhinUQpD6SKy"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x41a7f84bd3a02e7e5bea80580e40cec419d40ef9925a51cf0128ad84b40f8041",
                   "digest": "9tGfLEvq5kUWYBUaMVSH3Qu996sAv5XAPEXGUFcYecpU"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x46ea41cad4b69f493f5cf7fcb41c96e63ea97c206107d9b25d29a7d28f683ca7",
                   "digest": "D5vv7Xzd6uDWFuYTSEFvNgfXrRsXSDna9v7h4BK7xQcW"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x6af2a2b7ca60bf76174adfd3e9c4957f8e937759603182f9b46c7f6c5f19c6d2",
                   "digest": "BWHXYvVDVbLrXAWL91Bgid4Pu9oDyF8hZqNoFsZ6HM7w"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0xcfecb053c69314e75f36561910f3535dd466b6e2e3593708f370e80424617ae7",
                   "digest": "68NRbjATuQoyL78VTc3Gd96h2xoGmevmCpoAQzM7jghG"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0xd73b7dd2e4b15b4030f2d1af51a8e8335d37c9723565005f498df27d8a6d3a4d",
                   "digest": "2b3gYd9RreACiq2Cxv2LJyLS8PWHeXfDNeECYbVaf8FR"
@@ -276,8 +276,8 @@ Response: {
             "balanceChanges": [],
             "objectChanges": [
               {
-                "idCreated": null,
-                "idDeleted": null,
+                "idCreated": false,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x0000000000000000000000000000000000000000000000000000000000000006",
                   "digest": "28w3Mp2x4vt94bq4TejrbLcfMsMaevDyPz6h98sgcnw4"
@@ -361,31 +361,31 @@ Response: {
             "balanceChanges": [],
             "objectChanges": [
               {
-                "idCreated": null,
-                "idDeleted": null,
+                "idCreated": false,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x0000000000000000000000000000000000000000000000000000000000000005",
                   "digest": "5jzahJer9cg4yJaBZhjpEAbLtzHcKguzMtFBc1poL5fS"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0x5b890eaf2abcfa2ab90b77b8e6f3d5d8609586c3e583baf3dccd5af17edf48d1",
                   "digest": "Y4W89QnJVPhaMeoExCsfdQhF5bs5RELi5xjLgAy1h6a"
                 }
               },
               {
                 "idCreated": true,
-                "idDeleted": null,
+                "idDeleted": false,
                 "outputState": {
                   "location": "0xa84a25da7fef87ac6141a4920a87564ddb5bd8964333f04e7bd49facb831ba43",
                   "digest": "2dUtbkQSCPJewe9WJsxvAdu1rft1AVXwXMuWYFkYnAxr"
                 }
               },
               {
-                "idCreated": null,
+                "idCreated": false,
                 "idDeleted": true,
                 "outputState": null
               }

diff --git a/crates/sui-graphql-rpc/schema/current_progress_schema.graphql b/crates/sui-graphql-rpc/schema/current_progress_schema.graphql
@@ -1057,9 +1057,21 @@ type Object implements ObjectOwner {
 	dynamicFieldConnection(first: Int, after: String, last: Int, before: String): DynamicFieldConnection
 }
 
+"""
+Effect on an individual Object (keyed by its ID).
+"""
 type ObjectChange {
+	"""
+	The contents of the object at the end of the transaction.
+	"""
 	outputState: Object
+	"""
+	Whether the ID was created in this transaction.
+	"""
 	idCreated: Boolean
+	"""
+	Whether the ID was deleted in this transaction.
+	"""
 	idDeleted: Boolean
 }
 

diff --git a/crates/sui-graphql-rpc/src/types/mod.rs b/crates/sui-graphql-rpc/src/types/mod.rs
@@ -28,6 +28,7 @@ pub(crate) mod move_type;
 pub(crate) mod move_value;
 pub(crate) mod name_service;
 pub(crate) mod object;
+pub(crate) mod object_change;
 pub(crate) mod open_move_type;
 pub(crate) mod owner;
 pub(crate) mod protocol_config;