sui-sdk-types: remove digest wrappers and use Digest everywhere

The digest wrappers were not providing much value so to improve
ergonomics we'll use `Digest` everywhere.

Author: bmwill

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

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use sui_types::Address;
-use sui_types::TransactionDigest;
+use sui_types::Digest;
 
 use anyhow::bail;
 use reqwest::StatusCode;
@@ -42,7 +42,7 @@ pub struct FaucetResponse {
 pub struct CoinInfo {
     pub amount: u64,
     pub id: Address,
-    pub transfer_tx_digest: TransactionDigest,
+    pub transfer_tx_digest: Digest,
 }
 
 #[derive(Serialize, Deserialize, Error, Debug, PartialEq, Eq)]

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

@@ -83,15 +83,14 @@ use streams::stream_paginated_query;
 
 use sui_types::framework::Coin;
 use sui_types::Address;
-use sui_types::CheckpointDigest;
 use sui_types::CheckpointSequenceNumber;
 use sui_types::CheckpointSummary;
+use sui_types::Digest;
 use sui_types::Event;
 use sui_types::MovePackage;
 use sui_types::Object;
 use sui_types::SignedTransaction;
 use sui_types::Transaction;
-use sui_types::TransactionDigest;
 use sui_types::TransactionEffects;
 use sui_types::TransactionKind;
 use sui_types::TypeTag;
@@ -493,10 +492,7 @@ impl Client {
 
     /// The total number of transaction blocks in the network by the end of the provided
     /// checkpoint digest.
-    pub async fn total_transaction_blocks_by_digest(
-        &self,
-        digest: CheckpointDigest,
-    ) -> Result<Option<u64>> {
+    pub async fn total_transaction_blocks_by_digest(&self, digest: Digest) -> Result<Option<u64>> {
         self.internal_total_transaction_blocks(Some(digest.to_string()), None)
             .await
     }
@@ -655,7 +651,7 @@ impl Client {
     /// provided, it will use the last known checkpoint id.
     pub async fn checkpoint(
         &self,
-        digest: Option<CheckpointDigest>,
+        digest: Option<Digest>,
         seq_num: Option<u64>,
     ) -> Result<Option<CheckpointSummary>> {
         if digest.is_some() && seq_num.is_some() {
@@ -977,7 +973,7 @@ impl Client {
         &self,
         filter: Option<EventFilter>,
         pagination_filter: PaginationFilter,
-    ) -> Result<Page<(Event, TransactionDigest)>> {
+    ) -> Result<Page<(Event, Digest)>> {
         let (after, before, first, last) = self.pagination_filter(pagination_filter).await;
 
         let operation = EventsQuery::build(EventsQueryArgs {
@@ -1001,7 +997,7 @@ impl Client {
             let events_with_digests = ec
                 .nodes
                 .into_iter()
-                .map(|node| -> Result<(Event, TransactionDigest)> {
+                .map(|node| -> Result<(Event, Digest)> {
                     let event =
                         bcs::from_bytes::<Event>(&base64ct::Base64::decode_vec(&node.bcs.0)?)?;
 
@@ -1016,7 +1012,7 @@ impl Client {
                             )
                         })?;
 
-                    let tx_digest = TransactionDigest::from_base58(&tx_digest)?;
+                    let tx_digest = Digest::from_base58(&tx_digest)?;
 
                     Ok((event, tx_digest))
                 })
@@ -1033,7 +1029,7 @@ impl Client {
         &self,
         filter: Option<EventFilter>,
         streaming_direction: Direction,
-    ) -> impl Stream<Item = Result<(Event, TransactionDigest)>> + '_ {
+    ) -> impl Stream<Item = Result<(Event, Digest)>> + '_ {
         stream_paginated_query(
             move |pag_filter| self.events(filter.clone(), pag_filter),
             streaming_direction,
@@ -1489,10 +1485,7 @@ impl Client {
     // ===========================================================================
 
     /// Get a transaction by its digest.
-    pub async fn transaction(
-        &self,
-        digest: TransactionDigest,
-    ) -> Result<Option<SignedTransaction>> {
+    pub async fn transaction(&self, digest: Digest) -> Result<Option<SignedTransaction>> {
         let operation = TransactionBlockQuery::build(TransactionBlockArgs {
             digest: digest.to_string(),
         });
@@ -1510,10 +1503,7 @@ impl Client {
     }
 
     /// Get a transaction's effects by its digest.
-    pub async fn transaction_effects(
-        &self,
-        digest: TransactionDigest,
-    ) -> Result<Option<TransactionEffects>> {
+    pub async fn transaction_effects(&self, digest: Digest) -> Result<Option<TransactionEffects>> {
         let operation = TransactionBlockEffectsQuery::build(TransactionBlockArgs {
             digest: digest.to_string(),
         });
@@ -1529,7 +1519,7 @@ impl Client {
     /// Get a transaction's data and effects by its digest.
     pub async fn transaction_data_effects(
         &self,
-        digest: TransactionDigest,
+        digest: Digest,
     ) -> Result<Option<TransactionDataEffects>> {
         let operation = TransactionBlockWithEffectsQuery::build(TransactionBlockArgs {
             digest: digest.to_string(),

crates/sui-rpc/src/client/response_ext.rs

@@ -1,8 +1,8 @@
-use sui_sdk_types::CheckpointDigest;
+use sui_sdk_types::Digest;
 
 /// Extension trait used to facilitate retrieval of Sui specific data from responses
 pub trait ResponseExt: sealed::Sealed {
-    fn chain_id(&self) -> Option<CheckpointDigest>;
+    fn chain_id(&self) -> Option<Digest>;
     fn chain(&self) -> Option<&str>;
     fn epoch(&self) -> Option<u64>;
     fn checkpoint_height(&self) -> Option<u64>;
@@ -13,10 +13,10 @@ pub trait ResponseExt: sealed::Sealed {
 }
 
 impl ResponseExt for http::header::HeaderMap {
-    fn chain_id(&self) -> Option<CheckpointDigest> {
+    fn chain_id(&self) -> Option<Digest> {
         self.get(crate::headers::X_SUI_CHAIN_ID)
             .map(http::header::HeaderValue::as_bytes)
-            .and_then(|s| CheckpointDigest::from_base58(s).ok())
+            .and_then(|s| Digest::from_base58(s).ok())
     }
 
     fn chain(&self) -> Option<&str> {
@@ -61,7 +61,7 @@ impl ResponseExt for http::header::HeaderMap {
 }
 
 impl ResponseExt for tonic::metadata::MetadataMap {
-    fn chain_id(&self) -> Option<CheckpointDigest> {
+    fn chain_id(&self) -> Option<Digest> {
         self.as_ref().chain_id()
     }
 
@@ -95,7 +95,7 @@ impl ResponseExt for tonic::metadata::MetadataMap {
 }
 
 impl<T> ResponseExt for tonic::Response<T> {
-    fn chain_id(&self) -> Option<CheckpointDigest> {
+    fn chain_id(&self) -> Option<Digest> {
         self.metadata().chain_id()
     }
 
@@ -129,7 +129,7 @@ impl<T> ResponseExt for tonic::Response<T> {
 }
 
 impl ResponseExt for tonic::Status {
-    fn chain_id(&self) -> Option<CheckpointDigest> {
+    fn chain_id(&self) -> Option<Digest> {
         self.metadata().chain_id()
     }
 

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

@@ -1,12 +1,8 @@
-use super::CheckpointContentsDigest;
-use super::CheckpointDigest;
 use super::Digest;
 use super::GasCostSummary;
 use super::Object;
 use super::SignedTransaction;
-use super::TransactionDigest;
 use super::TransactionEffects;
-use super::TransactionEffectsDigest;
 use super::TransactionEvents;
 use super::UserSignature;
 use super::ValidatorAggregatedSignature;
@@ -126,12 +122,12 @@ pub struct CheckpointSummary {
     pub network_total_transactions: u64,
 
     /// The hash of the [`CheckpointContents`] for this checkpoint.
-    pub content_digest: CheckpointContentsDigest,
+    pub content_digest: Digest,
 
     /// The hash of the previous `CheckpointSummary`.
     ///
     /// This will be only be `None` for the first, or genesis checkpoint.
-    pub previous_digest: Option<CheckpointDigest>,
+    pub previous_digest: Option<Digest>,
 
     /// The running total gas costs of all transactions included in the current epoch so far
     /// until this checkpoint.
@@ -213,8 +209,8 @@ impl CheckpointContents {
 )]
 #[cfg_attr(feature = "proptest", derive(test_strategy::Arbitrary))]
 pub struct CheckpointTransactionInfo {
-    pub transaction: TransactionDigest,
-    pub effects: TransactionEffectsDigest,
+    pub transaction: Digest,
+    pub effects: Digest,
     #[cfg_attr(feature = "proptest", any(proptest::collection::size_range(0..=2).lift()))]
     pub signatures: Vec<UserSignature>,
 }
@@ -277,8 +273,8 @@ mod serialization {
 
             #[derive(serde_derive::Serialize)]
             struct Digests<'a> {
-                transaction: &'a TransactionDigest,
-                effects: &'a TransactionEffectsDigest,
+                transaction: &'a Digest,
+                effects: &'a Digest,
             }
 
             struct DigestSeq<'a>(&'a CheckpointContents);
@@ -322,8 +318,8 @@ mod serialization {
 
     #[derive(serde_derive::Deserialize)]
     struct ExecutionDigests {
-        transaction: TransactionDigest,
-        effects: TransactionEffectsDigest,
+        transaction: Digest,
+        effects: Digest,
     }
 
     #[derive(serde_derive::Deserialize)]

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

@@ -17,6 +17,8 @@
     derive(serde_derive::Serialize, serde_derive::Deserialize)
 )]
 #[cfg_attr(feature = "proptest", derive(test_strategy::Arbitrary))]
+#[doc(alias = "CheckpointDigest")]
+#[doc(alias = "TransactionDigest")]
 pub struct Digest(
     #[cfg_attr(feature = "serde", serde(with = "DigestSerialization"))] [u8; Self::LENGTH],
 );
@@ -201,138 +203,6 @@ impl std::fmt::Display for DigestParseError {
 
 impl std::error::Error for DigestParseError {}
 
-//
-// Implement Various Digest wrappers
-//
-
-macro_rules! impl_digest {
-    ($t:ident) => {
-        #[derive(Clone, Copy, Default, Hash, PartialEq, Eq, PartialOrd, Ord)]
-        #[cfg_attr(
-            feature = "serde",
-            derive(serde_derive::Serialize, serde_derive::Deserialize)
-        )]
-        #[cfg_attr(feature = "proptest", derive(test_strategy::Arbitrary))]
-        pub struct $t(Digest);
-
-        impl $t {
-            pub const LENGTH: usize = Digest::LENGTH;
-            pub const ZERO: Self = Self::new([0; Self::LENGTH]);
-
-            pub const fn new(digest: [u8; Self::LENGTH]) -> Self {
-                Self(Digest::new(digest))
-            }
-
-            #[cfg(feature = "rand")]
-            #[cfg_attr(doc_cfg, doc(cfg(feature = "rand")))]
-            pub fn generate<R>(rng: R) -> Self
-            where
-                R: rand_core::RngCore + rand_core::CryptoRng,
-            {
-                Self(Digest::generate(rng))
-            }
-
-            pub const fn inner(&self) -> &[u8; Self::LENGTH] {
-                self.0.inner()
-            }
-
-            pub const fn into_inner(self) -> [u8; Self::LENGTH] {
-                self.0.into_inner()
-            }
-
-            pub const fn as_bytes(&self) -> &[u8] {
-                self.0.as_bytes()
-            }
-
-            pub fn from_base58<T: AsRef<[u8]>>(base58: T) -> Result<Self, DigestParseError> {
-                Digest::from_base58(base58).map(Self)
-            }
-
-            #[allow(clippy::wrong_self_convention)]
-            pub fn to_base58(&self) -> String {
-                self.to_string()
-            }
-
-            pub fn from_bytes<T: AsRef<[u8]>>(bytes: T) -> Result<Self, DigestParseError> {
-                Digest::from_bytes(bytes).map(Self)
-            }
-        }
-
-        impl std::str::FromStr for $t {
-            type Err = DigestParseError;
-
-            fn from_str(s: &str) -> Result<Self, Self::Err> {
-                Self::from_base58(s)
-            }
-        }
-
-        impl AsRef<[u8]> for $t {
-            fn as_ref(&self) -> &[u8] {
-                self.0.as_ref()
-            }
-        }
-
-        impl AsRef<[u8; Self::LENGTH]> for $t {
-            fn as_ref(&self) -> &[u8; Self::LENGTH] {
-                self.0.as_ref()
-            }
-        }
-
-        impl From<$t> for [u8; $t::LENGTH] {
-            fn from(digest: $t) -> Self {
-                digest.into_inner()
-            }
-        }
-
-        impl From<[u8; Self::LENGTH]> for $t {
-            fn from(digest: [u8; Self::LENGTH]) -> Self {
-                Self::new(digest)
-            }
-        }
-
-        impl From<Digest> for $t {
-            fn from(digest: Digest) -> Self {
-                Self(digest)
-            }
-        }
-
-        impl From<$t> for Digest {
-            fn from(digest: $t) -> Self {
-                digest.0
-            }
-        }
-
-        impl std::fmt::Display for $t {
-            fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
-                std::fmt::Display::fmt(&self.0, f)
-            }
-        }
-
-        impl std::fmt::Debug for $t {
-            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-                f.debug_tuple(stringify!($t))
-                    .field(&format_args!("\"{}\"", self))
-                    .finish()
-            }
-        }
-
-        impl std::fmt::LowerHex for $t {
-            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-                std::fmt::LowerHex::fmt(&self.0, f)
-            }
-        }
-    };
-}
-
-impl_digest!(CheckpointDigest);
-impl_digest!(CheckpointContentsDigest);
-impl_digest!(TransactionDigest);
-impl_digest!(TransactionEffectsDigest);
-impl_digest!(TransactionEventsDigest);
-impl_digest!(ObjectDigest);
-impl_digest!(ConsensusCommitDigest);
-impl_digest!(EffectsAuxiliaryDataDigest);
-
 // Don't implement like the other digest types since this isn't intended to be serialized
 pub type SigningDigest = [u8; Digest::LENGTH];