sui-sdk-types: remove ObjectId type in favor of Address

Remove the Objectid type and instead directly use the Address type
everywhere. These two types were essentially identical to one another
already and this will make a number of apis easier to use now that you
don't need to worry about converting between the two.

Author: bmwill

crates/sui-graphql-client/src/faucet.rs

@@ -10,7 +10,6 @@ use reqwest::Url;
 use serde::Deserialize;
 use serde::Serialize;
 use serde_json::json;
-use sui_types::ObjectId;
 use thiserror::Error;
 use tracing::error as tracing_error;
 use tracing::info;
@@ -42,7 +41,7 @@ pub struct FaucetResponse {
 #[serde(rename_all = "camelCase")]
 pub struct CoinInfo {
     pub amount: u64,
-    pub id: ObjectId,
+    pub id: Address,
     pub transfer_tx_digest: TransactionDigest,
 }
 

crates/sui-graphql-client/src/query_types/dry_run.rs

@@ -49,9 +49,8 @@ pub struct ObjectRef {
 
 impl From<ObjectReference> for ObjectRef {
     fn from(value: ObjectReference) -> Self {
-        let address: Address = (*value.object_id()).into();
         ObjectRef {
-            address,
+            address: *value.object_id(),
             version: value.version(),
             digest: value.digest().to_string(),
         }

crates/sui-sdk-types/src/address.rs

@@ -14,10 +14,10 @@
 /// assert_eq!(hex, address.to_string());
 /// ```
 ///
-/// # Deriving an Address
+/// # Deriving an account Address
 ///
-/// Addresses are cryptographically derived from a number of user account authenticators, the simplest
-/// of which is an [`Ed25519PublicKey`](crate::Ed25519PublicKey).
+/// Account addresses are cryptographically derived from a number of user account authenticators,
+/// the simplest of which is an [`Ed25519PublicKey`](crate::Ed25519PublicKey).
 ///
 /// Deriving an address consists of the Blake2b256 hash of the sequence of bytes of its
 /// corresponding authenticator, prefixed with a domain-separator. For each authenticator, this
@@ -30,14 +30,16 @@
 ///
 /// [`Ed25519PublicKey::derive_address`]: crate::Ed25519PublicKey::derive_address
 ///
-/// ## Relationship to ObjectIds
+/// # Usage as ObjectIds
 ///
-/// [`ObjectId`]s and `Address`es share the same 32-byte addressable space but are derived
-/// leveraging different domain-separator values to ensure, cryptographically, that there won't be
-/// any overlap, e.g. there can't be a valid `Object` whose `ObjectId` is equal to that of the
+/// `Address`es are also used as a way to uniquely identify an [`Object`]. When an `Address` is
+/// used as an object identifierit can also be referred to as an `ObjectId`. `ObjectId`s and
+/// account `Address`es share the same 32-byte addressable space but are derived leveraging
+/// different domain-separator values to ensure, cryptographically, that there won't be any
+/// overlap, e.g. there can't be a valid `Object` whose `ObjectId` is equal to that of the
 /// `Address` of a user account.
 ///
-/// [`ObjectId`]: crate::ObjectId
+/// [`Object`]: crate::Object
 ///
 /// # BCS
 ///
@@ -52,6 +54,7 @@
     derive(serde_derive::Serialize, serde_derive::Deserialize)
 )]
 #[cfg_attr(feature = "proptest", derive(test_strategy::Arbitrary))]
+#[doc(alias = "ObjectId")]
 pub struct Address(
     #[cfg_attr(
         feature = "serde",
@@ -174,12 +177,6 @@ impl From<Address> for Vec<u8> {
     }
 }
 
-impl From<super::ObjectId> for Address {
-    fn from(value: super::ObjectId) -> Self {
-        Self::new(value.into_inner())
-    }
-}
-
 impl std::fmt::Display for Address {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         write!(f, "0x")?;

crates/sui-sdk-types/src/effects/v1.rs

@@ -1,9 +1,9 @@
 use crate::execution_status::ExecutionStatus;
 use crate::object::Owner;
 use crate::object::Version;
+use crate::Address;
 use crate::EpochId;
 use crate::GasCostSummary;
-use crate::ObjectId;
 use crate::ObjectReference;
 use crate::TransactionDigest;
 use crate::TransactionEventsDigest;
@@ -105,7 +105,7 @@ pub struct TransactionEffectsV1 {
 /// The BCS serialized form for this type is defined by the following ABNF:
 ///
 /// ```text
-/// modified-at-version = object-id u64
+/// modified-at-version = address u64
 /// ```
 #[derive(Eq, PartialEq, Clone, Debug)]
 #[cfg_attr(
@@ -114,7 +114,7 @@ pub struct TransactionEffectsV1 {
 )]
 #[cfg_attr(feature = "proptest", derive(test_strategy::Arbitrary))]
 pub struct ModifiedAtVersion {
-    pub object_id: ObjectId,
+    pub object_id: Address,
     pub version: Version,
 }
 

crates/sui-sdk-types/src/effects/v2.rs

@@ -2,10 +2,10 @@ use crate::digest::EffectsAuxiliaryDataDigest;
 use crate::execution_status::ExecutionStatus;
 use crate::object::Owner;
 use crate::object::Version;
+use crate::Address;
 use crate::EpochId;
 use crate::GasCostSummary;
 use crate::ObjectDigest;
-use crate::ObjectId;
 use crate::TransactionDigest;
 use crate::TransactionEventsDigest;
 
@@ -87,7 +87,7 @@ pub struct TransactionEffectsV2 {
 /// The BCS serialized form for this type is defined by the following ABNF:
 ///
 /// ```text
-/// changed-object = object-id object-in object-out id-operation
+/// changed-object = address object-in object-out id-operation
 /// ```
 #[derive(Eq, PartialEq, Clone, Debug)]
 #[cfg_attr(
@@ -97,7 +97,7 @@ pub struct TransactionEffectsV2 {
 #[cfg_attr(feature = "proptest", derive(test_strategy::Arbitrary))]
 pub struct ChangedObject {
     /// Id of the object
-    pub object_id: ObjectId,
+    pub object_id: Address,
 
     /// State of the object in the store prior to this transaction.
     pub input_state: ObjectIn,
@@ -118,7 +118,7 @@ pub struct ChangedObject {
 /// The BCS serialized form for this type is defined by the following ABNF:
 ///
 /// ```text
-/// unchanged-shared-object = object-id unchanged-shared-object-kind
+/// unchanged-shared-object = address unchanged-shared-object-kind
 /// ```
 #[derive(Eq, PartialEq, Clone, Debug)]
 #[cfg_attr(
@@ -127,7 +127,7 @@ pub struct ChangedObject {
 )]
 #[cfg_attr(feature = "proptest", derive(test_strategy::Arbitrary))]
 pub struct UnchangedSharedObject {
-    pub object_id: ObjectId,
+    pub object_id: Address,
     pub kind: UnchangedSharedKind,
 }
 

crates/sui-sdk-types/src/events.rs

@@ -1,6 +1,5 @@
 use super::Address;
 use super::Identifier;
-use super::ObjectId;
 use super::StructTag;
 use super::TypeTag;
 
@@ -31,7 +30,7 @@ pub struct TransactionEvents(
 /// The BCS serialized form for this type is defined by the following ABNF:
 ///
 /// ```text
-/// event = object-id identifier address struct-tag bytes
+/// event = address identifier address struct-tag bytes
 /// ```
 #[derive(PartialEq, Eq, Debug, Clone)]
 #[cfg_attr(
@@ -42,7 +41,7 @@ pub struct TransactionEvents(
 pub struct Event {
     /// Package id of the top-level function invoked by a MoveCall command which triggered this
     /// event to be emitted.
-    pub package_id: ObjectId,
+    pub package_id: Address,
 
     /// Module name of the top-level function invoked by a MoveCall command which triggered this
     /// event to be emitted.

crates/sui-sdk-types/src/execution_status.rs

@@ -1,7 +1,6 @@
 use super::Address;
 use super::Digest;
 use super::Identifier;
-use super::ObjectId;
 
 /// The status of an executed Transaction
 ///
@@ -89,7 +88,7 @@ pub enum ExecutionStatus {
 /// feature-not-yet-supported                           = %x03
 /// object-too-big                                      = %x04 u64 u64
 /// package-too-big                                     = %x05 u64 u64
-/// circular-object-ownership                           = %x06 object-id
+/// circular-object-ownership                           = %x06 address
 /// insufficient-coin-balance                           = %x07
 /// coin-balance-overflow                               = %x08
 /// publish-error-non-zero-address                      = %x09
@@ -116,7 +115,7 @@ pub enum ExecutionStatus {
 /// sui-move-verification-timedout                      = %x1e
 /// shared-object-operation-not-allowed                 = %x1f
 /// input-object-deleted                                = %x20
-/// execution-canceled-due-to-shared-object-congestion = %x21 (vector object-id)
+/// execution-canceled-due-to-shared-object-congestion = %x21 (vector address)
 /// address-denied-for-coin                             = %x22 address string
 /// coin-type-global-pause                              = %x23 string
 /// execution-canceled-due-to-randomness-unavailable   = %x24
@@ -150,7 +149,7 @@ pub enum ExecutionError {
         max_object_size: u64,
     },
     /// Circular Object Ownership
-    CircularObjectOwnership { object: ObjectId },
+    CircularObjectOwnership { object: Address },
 
     //
     // Coin errors
@@ -256,7 +255,7 @@ pub enum ExecutionError {
     /// Certificate is canceled due to congestion on shared objects
     ExecutionCanceledDueToSharedObjectCongestion {
         #[cfg_attr(feature = "proptest", any(proptest::collection::size_range(0..=1).lift()))]
-        congested_objects: Vec<ObjectId>,
+        congested_objects: Vec<Address>,
     },
 
     /// Address is denied for this coin type
@@ -295,7 +294,7 @@ pub enum ExecutionError {
 /// The BCS serialized form for this type is defined by the following ABNF:
 ///
 /// ```text
-/// move-location = object-id identifier u16 u16 (option identifier)
+/// move-location = address identifier u16 u16 (option identifier)
 /// ```
 #[derive(Eq, PartialEq, Clone, Debug)]
 #[cfg_attr(
@@ -305,7 +304,7 @@ pub enum ExecutionError {
 #[cfg_attr(feature = "proptest", derive(test_strategy::Arbitrary))]
 pub struct MoveLocation {
     /// The package id
-    pub package: ObjectId,
+    pub package: Address,
 
     /// The module name
     pub module: Identifier,
@@ -423,12 +422,12 @@ pub enum CommandArgumentError {
 ///                         unknown-upgrade-policy  /
 ///                         package-id-does-not-match
 ///
-/// unable-to-fetch-package     = %x00 object-id
-/// not-a-package               = %x01 object-id
+/// unable-to-fetch-package     = %x00 address
+/// not-a-package               = %x01 address
 /// incompatible-upgrade        = %x02
 /// digest-does-not-match       = %x03 digest
 /// unknown-upgrade-policy      = %x04 u8
-/// package-id-does-not-match   = %x05 object-id object-id
+/// package-id-does-not-match   = %x05 address address
 /// ```
 #[derive(Eq, PartialEq, Clone, Debug)]
 #[cfg_attr(
@@ -438,10 +437,10 @@ pub enum CommandArgumentError {
 #[cfg_attr(feature = "proptest", derive(test_strategy::Arbitrary))]
 pub enum PackageUpgradeError {
     /// Unable to fetch package
-    UnableToFetchPackage { package_id: ObjectId },
+    UnableToFetchPackage { package_id: Address },
 
     /// Object is not a package
-    NotAPackage { object_id: ObjectId },
+    NotAPackage { object_id: Address },
 
     /// Package upgrade is incompatible with previous version
     IncompatibleUpgrade,
@@ -454,8 +453,8 @@ pub enum PackageUpgradeError {
 
     /// PackageId does not matach PackageId in upgrade ticket
     PackageIdDoesNotMatch {
-        package_id: ObjectId,
-        ticket_id: ObjectId,
+        package_id: Address,
+        ticket_id: Address,
     },
 }
 

crates/sui-sdk-types/src/framework.rs

@@ -1,14 +1,14 @@
 //! Rust definitions of move/sui framework types.
 
+use super::Address;
 use super::Object;
-use super::ObjectId;
 use super::TypeTag;
 use std::borrow::Cow;
 
 #[derive(Debug, Clone)]
 pub struct Coin<'a> {
     coin_type: Cow<'a, TypeTag>,
-    id: ObjectId,
+    id: Address,
     balance: u64,
 }
 
@@ -17,7 +17,7 @@ impl<'a> Coin<'a> {
         &self.coin_type
     }
 
-    pub fn id(&self) -> &ObjectId {
+    pub fn id(&self) -> &Address {
         &self.id
     }
 
@@ -31,13 +31,13 @@ impl<'a> Coin<'a> {
                 let coin_type = move_struct.type_.is_coin()?;
 
                 let contents = &move_struct.contents;
-                if contents.len() != ObjectId::LENGTH + std::mem::size_of::<u64>() {
+                if contents.len() != Address::LENGTH + std::mem::size_of::<u64>() {
                     return None;
                 }
 
-                let id = ObjectId::new((&contents[..ObjectId::LENGTH]).try_into().unwrap());
+                let id = Address::new((&contents[..Address::LENGTH]).try_into().unwrap());
                 let balance =
-                    u64::from_le_bytes((&contents[ObjectId::LENGTH..]).try_into().unwrap());
+                    u64::from_le_bytes((&contents[Address::LENGTH..]).try_into().unwrap());
 
                 Some(Self {
                     coin_type: Cow::Borrowed(coin_type),

crates/sui-sdk-types/src/hash.rs

@@ -425,7 +425,7 @@ enum HashingIntent {
     RegularObjectId = 0xf1,
 }
 
-impl crate::ObjectId {
+impl crate::Address {
     /// Create an ObjectId from `TransactionDigest` and `count`.
     ///
     /// `count` is the number of objects that have been created during a transactions.

crates/sui-sdk-types/src/lib.rs

@@ -105,7 +105,6 @@ mod execution_status;
 pub mod framework;
 mod gas;
 mod object;
-mod object_id;
 mod transaction;
 mod type_tag;
 mod u256;
@@ -208,7 +207,6 @@ pub use object::Owner;
 pub use object::TypeOrigin;
 pub use object::UpgradeInfo;
 pub use object::Version;
-pub use object_id::ObjectId;
 pub use transaction::ActiveJwk;
 pub use transaction::Argument;
 pub use transaction::AuthenticatorStateExpire;