[#3992][Events] Extract amount field from coins into TransferObject e…

…vent (#4328)
MystenLabs · Sep 2, 2022 · 32b96ec · 32b96ec
1 parent ed4258a
commit 32b96ec
Show file tree

Hide file tree

Showing 19 changed files with 876 additions and 754 deletions.
diff --git a/crates/sui-adapter/src/adapter.rs b/crates/sui-adapter/src/adapter.rs
@@ -26,6 +26,7 @@ use move_vm_runtime::{native_functions::NativeFunctionTable, session::Serialized
 use sui_framework::EventType;
 use sui_types::{
     base_types::*,
+    coin::Coin,
     error::ExecutionError,
     error::{ExecutionErrorKind, SuiError},
     event::{Event, TransferType},
@@ -798,6 +799,13 @@ fn handle_transfer<
             _ => None,
         };
         if let Some(type_) = transfer_type {
+            // Check for the transfer amount if the object is a Coin
+            let amount = if Coin::is_coin(&move_obj.type_) {
+                let coin = Coin::from_bcs_bytes(move_obj.contents())?;
+                Some(coin.value())
+            } else {
+                None
+            };
             state_view.log_event(Event::TransferObject {
                 package_id: ObjectID::from(*module_id.address()),
                 transaction_module: Identifier::from(module_id.name()),
@@ -806,6 +814,7 @@ fn handle_transfer<
                 object_id: obj_id,
                 version: old_obj_ver,
                 type_,
+                amount,
             })
         }
     } else {

diff --git a/crates/sui-cluster-test/src/helper.rs b/crates/sui-cluster-test/src/helper.rs
@@ -160,6 +160,7 @@ pub struct TransferObjectEventChecker {
     object_id: Option<ObjectID>,
     version: Option<SequenceNumber>,
     type_: Option<TransferType>,
+    amount: Option<u64>,
 }
 
 impl TransferObjectEventChecker {
@@ -196,6 +197,11 @@ impl TransferObjectEventChecker {
         self
     }
 
+    pub fn amount(mut self, amount: u64) -> Self {
+        self.amount = Some(amount);
+        self
+    }
+
     pub fn check(self, event: &SuiEvent) {
         if let SuiEvent::TransferObject {
             package_id,
@@ -205,6 +211,7 @@ impl TransferObjectEventChecker {
             object_id,
             version,
             type_,
+            amount,
         } = event
         {
             assert_eq_if_present!(self.package_id, package_id, "package_id");
@@ -218,6 +225,7 @@ impl TransferObjectEventChecker {
             assert_eq_if_present!(self.object_id, object_id, "object_id");
             assert_eq_if_present!(self.version, version, "version");
             assert_eq_if_present!(self.type_, type_, "type_");
+            assert_eq!(self.amount, *amount);
         } else {
             panic!("event {:?} is not TransferObject Event", event);
         }

diff --git a/crates/sui-cluster-test/src/test_case/native_transfer_test.rs b/crates/sui-cluster-test/src/test_case/native_transfer_test.rs
@@ -74,6 +74,7 @@ impl TestCaseImpl for NativeTransferTest {
             .recipient(Owner::AddressOwner(recipient_addr))
             .object_id(*obj_to_transfer.id())
             .type_(TransferType::Coin)
+            .amount(50000)
             .check(&event);
 
         // Verify fullnode observes the txn

diff --git a/crates/sui-core/src/execution_engine.rs b/crates/sui-core/src/execution_engine.rs
@@ -11,6 +11,7 @@ use crate::authority::TemporaryStore;
 use move_core_types::language_storage::ModuleId;
 use move_vm_runtime::{move_vm::MoveVM, native_functions::NativeFunctionTable};
 use sui_adapter::adapter;
+use sui_types::coin::Coin;
 use sui_types::committee::EpochId;
 use sui_types::error::ExecutionError;
 use sui_types::gas::GasCostSummary;
@@ -260,6 +261,8 @@ fn transfer_object<S>(
 ) -> Result<(), ExecutionError> {
     object.ensure_public_transfer_eligible()?;
     object.transfer_and_increment_version(recipient);
+    // This will extract the transfer amount if the object is a Coin of some kind
+    let amount = Coin::extract_balance_if_coin(&object)?;
     temporary_store.log_event(Event::TransferObject {
         package_id: ObjectID::from(SUI_FRAMEWORK_ADDRESS),
         transaction_module: Identifier::from(ident_str!("native")),
@@ -268,6 +271,7 @@ fn transfer_object<S>(
         object_id: object.id(),
         version: object.version(),
         type_: TransferType::Coin,
+        amount,
     });
     temporary_store.write_object(object);
     Ok(())
@@ -290,7 +294,7 @@ fn transfer_sui<S>(
     #[cfg(debug_assertions)]
     let version = object.version();
 
-    if let Some(amount) = amount {
+    let transferred = if let Some(amount) = amount {
         // Deduct the amount from the gas coin and update it.
         let mut gas_coin = GasCoin::try_from(&object)
             .expect("gas object is transferred, so already checked to be a SUI coin");
@@ -319,13 +323,24 @@ fn transfer_sui<S>(
         // This is necessary for the temporary store to know this new object is not unwrapped.
         let newly_generated_ids = tx_ctx.recreate_all_ids();
         temporary_store.set_create_object_ids(newly_generated_ids);
+        Some(amount)
     } else {
         // If amount is not specified, we simply transfer the entire coin object.
         // We don't want to increment the version number yet because latter gas charge will do it.
         object.transfer_without_version_change(recipient);
-    }
+        Coin::extract_balance_if_coin(&object)?
+    };
 
-    // TODO: Emit a new event type for this.
+    temporary_store.log_event(Event::TransferObject {
+        package_id: ObjectID::from(SUI_FRAMEWORK_ADDRESS),
+        transaction_module: Identifier::from(ident_str!("native")),
+        sender: tx_ctx.sender(),
+        recipient: Owner::AddressOwner(recipient),
+        object_id: object.id(),
+        version: object.version(),
+        type_: TransferType::Coin, // Should this be a separate type, like SuiCoin?
+        amount: transferred,
+    });
 
     #[cfg(debug_assertions)]
     assert_eq!(object.version(), version);

diff --git a/crates/sui-core/tests/staged/sui.yaml b/crates/sui-core/tests/staged/sui.yaml
@@ -136,65 +136,67 @@ ExecutionFailureStatus:
     8:
       InvalidTransferSuiInsufficientBalance: UNIT
     9:
-      NonEntryFunctionInvoked: UNIT
+      InvalidCoinObject: UNIT
     10:
-      EntryTypeArityMismatch: UNIT
+      NonEntryFunctionInvoked: UNIT
     11:
+      EntryTypeArityMismatch: UNIT
+    12:
       EntryArgumentError:
         NEWTYPE:
           TYPENAME: EntryArgumentError
-    12:
+    13:
       CircularObjectOwnership:
         NEWTYPE:
           TYPENAME: CircularObjectOwnership
-    13:
+    14:
       MissingObjectOwner:
         NEWTYPE:
           TYPENAME: MissingObjectOwner
-    14:
+    15:
       InvalidSharedChildUse:
         NEWTYPE:
           TYPENAME: InvalidSharedChildUse
-    15:
+    16:
       InvalidSharedByValue:
         NEWTYPE:
           TYPENAME: InvalidSharedByValue
-    16:
+    17:
       TooManyChildObjects:
         STRUCT:
           - object:
               TYPENAME: ObjectID
-    17:
+    18:
       InvalidParentDeletion:
         STRUCT:
           - parent:
               TYPENAME: ObjectID
           - kind:
               OPTION:
                 TYPENAME: DeleteKind
-    18:
+    19:
       InvalidParentFreezing:
         STRUCT:
           - parent:
               TYPENAME: ObjectID
-    19:
-      PublishErrorEmptyPackage: UNIT
     20:
-      PublishErrorNonZeroAddress: UNIT
+      PublishErrorEmptyPackage: UNIT
     21:
-      PublishErrorDuplicateModule: UNIT
+      PublishErrorNonZeroAddress: UNIT
     22:
-      SuiMoveVerificationError: UNIT
+      PublishErrorDuplicateModule: UNIT
     23:
-      MovePrimitiveRuntimeError: UNIT
+      SuiMoveVerificationError: UNIT
     24:
+      MovePrimitiveRuntimeError: UNIT
+    25:
       MoveAbort:
         TUPLE:
           - TYPENAME: ModuleId
           - U64
-    25:
-      VMVerificationOrDeserializationError: UNIT
     26:
+      VMVerificationOrDeserializationError: UNIT
+    27:
       VMInvariantViolation: UNIT
 ExecutionStatus:
   ENUM:

diff --git a/crates/sui-json-rpc-types/src/lib.rs b/crates/sui-json-rpc-types/src/lib.rs
@@ -1758,6 +1758,7 @@ pub enum SuiEvent {
         object_id: ObjectID,
         version: SequenceNumber,
         type_: TransferType,
+        amount: Option<u64>,
     },
     /// Delete object
     #[serde(rename_all = "camelCase")]
@@ -1825,6 +1826,7 @@ impl SuiEvent {
                 object_id,
                 version,
                 type_,
+                amount,
             } => SuiEvent::TransferObject {
                 package_id,
                 transaction_module: transaction_module.to_string(),
@@ -1833,6 +1835,7 @@ impl SuiEvent {
                 object_id,
                 version,
                 type_,
+                amount,
             },
             Event::DeleteObject {
                 package_id,
@@ -1918,6 +1921,7 @@ impl PartialEq<SuiEvent> for Event {
                 type_: self_type,
                 object_id: self_object_id,
                 version: self_version,
+                amount: self_amount,
             } => {
                 if let SuiEvent::TransferObject {
                     package_id,
@@ -1927,6 +1931,7 @@ impl PartialEq<SuiEvent> for Event {
                     object_id,
                     version,
                     type_,
+                    amount,
                 } = other
                 {
                     package_id == self_package_id
@@ -1936,6 +1941,7 @@ impl PartialEq<SuiEvent> for Event {
                         && self_object_id == object_id
                         && self_version == version
                         && self_type == type_
+                        && self_amount == amount
                 } else {
                     false
                 }

diff --git a/crates/sui-open-rpc/samples/objects.json b/crates/sui-open-rpc/samples/objects.json
@@ -9,21 +9,21 @@
         "fields": {
           "description": "An NFT created by the Sui Command Line Tool",
           "id": {
-            "id": "0xed50d0e9db53a2c9cfc4f0f4c7639fa63785f7e8"
+            "id": "0x1e8e405f6fb3e6f7566cfbd2f05a112ce81024a7"
           },
           "name": "Example NFT",
           "url": "ipfs://bafkreibngqhl3gaa7daob4i2vccziay2jjlp435cf66vhono7nrvww53ty"
         }
       },
       "owner": {
-        "AddressOwner": "0x2d08997bd97399b19039dda9a00595d059b50bd4"
+        "AddressOwner": "0x226c0b18b03eaebee3db1a2e4613c29eddb216e6"
       },
-      "previousTransaction": "isMsSeqggHGpjP4jfjmCdUzuQqXH2K/d4LwILffRW3Y=",
+      "previousTransaction": "2ELWlyt4F1JkZvg83l6G1lZnrwRy9A6XOy/fqidfOHs=",
       "storageRebate": 25,
       "reference": {
-        "objectId": "0xed50d0e9db53a2c9cfc4f0f4c7639fa63785f7e8",
+        "objectId": "0x1e8e405f6fb3e6f7566cfbd2f05a112ce81024a7",
         "version": 1,
-        "digest": "Anb5B9SULTxWoJ8j5bB5RTg5eo/F683jgWncYOxDlHc="
+        "digest": "pgFtd238r5ahpT5DHYFu8+8iqNJxOP6a9rnJIwbScvA="
       }
     }
   },
@@ -37,19 +37,19 @@
         "fields": {
           "balance": 100000000,
           "id": {
-            "id": "0x0bb17115dde7633421736a7618d3be02336b7c25"
+            "id": "0x02ed45cab5c1f60e26b77cca50054e12280d624b"
           }
         }
       },
       "owner": {
-        "AddressOwner": "0x2d08997bd97399b19039dda9a00595d059b50bd4"
+        "AddressOwner": "0x226c0b18b03eaebee3db1a2e4613c29eddb216e6"
       },
       "previousTransaction": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
       "storageRebate": 0,
       "reference": {
-        "objectId": "0x0bb17115dde7633421736a7618d3be02336b7c25",
+        "objectId": "0x02ed45cab5c1f60e26b77cca50054e12280d624b",
         "version": 0,
-        "digest": "Nh5q/N12r6r0W+4y2M1u/bJvM5aKDT+/R3uWmZEMtb8="
+        "digest": "DYGVPcOLk7d0FSbMEsAQUUwx9tQAGDF9qlls2Aix2TQ="
       }
     }
   },
@@ -59,16 +59,16 @@
       "data": {
         "dataType": "package",
         "disassembled": {
-          "m1": "// Move bytecode v5\nmodule c859504b7eb1baf927ea7c0f980908dada2c840a.m1 {\nstruct Forge has store, key {\n\tid: UID,\n\tswords_created: u64\n}\nstruct Sword has store, key {\n\tid: UID,\n\tmagic: u64,\n\tstrength: u64\n}\n\ninit(Arg0: &mut TxContext) {\nB0:\n\t0: CopyLoc[0](Arg0: &mut TxContext)\n\t1: Call[6](new(&mut TxContext): UID)\n\t2: LdU64(0)\n\t3: Pack[0](Forge)\n\t4: StLoc[1](loc0: Forge)\n\t5: MoveLoc[1](loc0: Forge)\n\t6: MoveLoc[0](Arg0: &mut TxContext)\n\t7: FreezeRef\n\t8: Call[7](sender(&TxContext): address)\n\t9: Call[0](transfer<Forge>(Forge, address))\n\t10: Ret\n}\npublic magic(Arg0: &Sword): u64 {\nB0:\n\t0: MoveLoc[0](Arg0: &Sword)\n\t1: ImmBorrowField[0](Sword.magic: u64)\n\t2: ReadRef\n\t3: Ret\n}\npublic strength(Arg0: &Sword): u64 {\nB0:\n\t0: MoveLoc[0](Arg0: &Sword)\n\t1: ImmBorrowField[1](Sword.strength: u64)\n\t2: ReadRef\n\t3: Ret\n}\nentry public sword_create(Arg0: &mut Forge, Arg1: u64, Arg2: u64, Arg3: address, Arg4: &mut TxContext) {\nB0:\n\t0: MoveLoc[4](Arg4: &mut TxContext)\n\t1: Call[6](new(&mut TxContext): UID)\n\t2: MoveLoc[1](Arg1: u64)\n\t3: MoveLoc[2](Arg2: u64)\n\t4: Pack[1](Sword)\n\t5: StLoc[5](loc0: Sword)\n\t6: MoveLoc[5](loc0: Sword)\n\t7: MoveLoc[3](Arg3: address)\n\t8: Call[1](transfer<Sword>(Sword, address))\n\t9: CopyLoc[0](Arg0: &mut Forge)\n\t10: ImmBorrowField[2](Forge.swords_created: u64)\n\t11: ReadRef\n\t12: LdU64(1)\n\t13: Add\n\t14: MoveLoc[0](Arg0: &mut Forge)\n\t15: MutBorrowField[2](Forge.swords_created: u64)\n\t16: WriteRef\n\t17: Ret\n}\nentry public sword_transfer(Arg0: Sword, Arg1: address) {\nB0:\n\t0: MoveLoc[0](Arg0: Sword)\n\t1: MoveLoc[1](Arg1: address)\n\t2: Call[1](transfer<Sword>(Sword, address))\n\t3: Ret\n}\npublic swords_created(Arg0: &Forge): u64 {\nB0:\n\t0: MoveLoc[0](Arg0: &Forge)\n\t1: ImmBorrowField[2](Forge.swords_created: u64)\n\t2: ReadRef\n\t3: Ret\n}\n}"
+          "m1": "// Move bytecode v5\nmodule 33c8739d658297e0aa49d5ed26b1c4be94dd47fd.m1 {\nstruct Forge has store, key {\n\tid: UID,\n\tswords_created: u64\n}\nstruct Sword has store, key {\n\tid: UID,\n\tmagic: u64,\n\tstrength: u64\n}\n\ninit(Arg0: &mut TxContext) {\nB0:\n\t0: CopyLoc[0](Arg0: &mut TxContext)\n\t1: Call[6](new(&mut TxContext): UID)\n\t2: LdU64(0)\n\t3: Pack[0](Forge)\n\t4: StLoc[1](loc0: Forge)\n\t5: MoveLoc[1](loc0: Forge)\n\t6: MoveLoc[0](Arg0: &mut TxContext)\n\t7: FreezeRef\n\t8: Call[7](sender(&TxContext): address)\n\t9: Call[0](transfer<Forge>(Forge, address))\n\t10: Ret\n}\npublic magic(Arg0: &Sword): u64 {\nB0:\n\t0: MoveLoc[0](Arg0: &Sword)\n\t1: ImmBorrowField[0](Sword.magic: u64)\n\t2: ReadRef\n\t3: Ret\n}\npublic strength(Arg0: &Sword): u64 {\nB0:\n\t0: MoveLoc[0](Arg0: &Sword)\n\t1: ImmBorrowField[1](Sword.strength: u64)\n\t2: ReadRef\n\t3: Ret\n}\nentry public sword_create(Arg0: &mut Forge, Arg1: u64, Arg2: u64, Arg3: address, Arg4: &mut TxContext) {\nB0:\n\t0: MoveLoc[4](Arg4: &mut TxContext)\n\t1: Call[6](new(&mut TxContext): UID)\n\t2: MoveLoc[1](Arg1: u64)\n\t3: MoveLoc[2](Arg2: u64)\n\t4: Pack[1](Sword)\n\t5: StLoc[5](loc0: Sword)\n\t6: MoveLoc[5](loc0: Sword)\n\t7: MoveLoc[3](Arg3: address)\n\t8: Call[1](transfer<Sword>(Sword, address))\n\t9: CopyLoc[0](Arg0: &mut Forge)\n\t10: ImmBorrowField[2](Forge.swords_created: u64)\n\t11: ReadRef\n\t12: LdU64(1)\n\t13: Add\n\t14: MoveLoc[0](Arg0: &mut Forge)\n\t15: MutBorrowField[2](Forge.swords_created: u64)\n\t16: WriteRef\n\t17: Ret\n}\nentry public sword_transfer(Arg0: Sword, Arg1: address) {\nB0:\n\t0: MoveLoc[0](Arg0: Sword)\n\t1: MoveLoc[1](Arg1: address)\n\t2: Call[1](transfer<Sword>(Sword, address))\n\t3: Ret\n}\npublic swords_created(Arg0: &Forge): u64 {\nB0:\n\t0: MoveLoc[0](Arg0: &Forge)\n\t1: ImmBorrowField[2](Forge.swords_created: u64)\n\t2: ReadRef\n\t3: Ret\n}\n}"
         }
       },
       "owner": "Immutable",
-      "previousTransaction": "Be64kF6cWEYihWgwYgzKvyMZNixU5JRKBWvqgiagB1s=",
+      "previousTransaction": "OpmWAAt95ttoaSlhcim8NEn/2fhOQbaWzljP1ozB2aI=",
       "storageRebate": 0,
       "reference": {
-        "objectId": "0xc859504b7eb1baf927ea7c0f980908dada2c840a",
+        "objectId": "0x33c8739d658297e0aa49d5ed26b1c4be94dd47fd",
         "version": 1,
-        "digest": "yKbnwGKWpCEiK0UaxQlOXxoTGvNUvc+KJONSVt+a9QE="
+        "digest": "SfTD5O4aBKYVN81rnGoe0NEBp8TazXFVbeitlVMT7Pg="
       }
     }
   },
@@ -77,22 +77,22 @@
     "details": {
       "data": {
         "dataType": "moveObject",
-        "type": "0xeaa96afeecd3cf700ca68d6cad4af93f05b59bcd::hero::Hero",
+        "type": "0x7c9b26e2c8ddff67419256af26fe5f1eddcf0fa7::hero::Hero",
         "has_public_transfer": true,
         "fields": {
           "experience": 0,
-          "game_id": "0x3e2f9cf92b994dd41d1eed32a05095bcb97ba403",
+          "game_id": "0x0b074aadeb6657f11e8da9b14dde1b943479d22f",
           "hp": 100,
           "id": {
-            "id": "0x1f45933e11d09fa15e65ba6735ce4205c3deec24"
+            "id": "0x5653a665c3b63f686f480fe3dd2c38ea8a15ed7c"
           },
 
           "sword": {
-            "type": "0xeaa96afeecd3cf700ca68d6cad4af93f05b59bcd::hero::Sword",
+            "type": "0x7c9b26e2c8ddff67419256af26fe5f1eddcf0fa7::hero::Sword",
             "fields": {
-              "game_id": "0x3e2f9cf92b994dd41d1eed32a05095bcb97ba403",
+              "game_id": "0x0b074aadeb6657f11e8da9b14dde1b943479d22f",
               "id": {
-                "id": "0xefda1238171072e9dda0d1e2a20e584d399e4a93"
+                "id": "0xfe0a8b7af6af8b87a4a942bd4c80de288f4a4a50"
               },
               "magic": 10,
               "strength": 1
@@ -101,14 +101,14 @@
         }
       },
       "owner": {
-        "AddressOwner": "0x2d08997bd97399b19039dda9a00595d059b50bd4"
+        "AddressOwner": "0x226c0b18b03eaebee3db1a2e4613c29eddb216e6"
       },
-      "previousTransaction": "l2NgFk9pnshb2qn/14mlS4B63rc+2BKLgktEuyyk4M8=",
+      "previousTransaction": "uPtcs0LiTGhOqSiJFVfWBPaicQGF4a6rBvgHdH3JAbw=",
       "storageRebate": 21,
       "reference": {
-        "objectId": "0x1f45933e11d09fa15e65ba6735ce4205c3deec24",
+        "objectId": "0x5653a665c3b63f686f480fe3dd2c38ea8a15ed7c",
         "version": 1,
-        "digest": "JLfV8R0HBVKX0BVGvzxP+Fzi/ghbZLkObAIzm0vGoLU="
+        "digest": "OYmwHOxXeJrmzBxlDpxCWRz3V8RD8hQ5vcR9Kzc1yzk="
       }
     }
   }