[refactor]: Rename item identifiers so that they are globally unique

Signed-off-by: Marin Veršić <marin.versic101@gmail.com>

Author: mversic

cli/src/samples.rs

@@ -8,7 +8,7 @@ use iroha_config::{
     torii::{uri::DEFAULT_API_URL, DEFAULT_TORII_P2P_ADDR, DEFAULT_TORII_TELEMETRY_URL},
 };
 use iroha_crypto::{KeyPair, PublicKey};
-use iroha_data_model::peer::Id as PeerId;
+use iroha_data_model::peer::PeerId;
 
 /// Get sample trusted peers. The public key must be the same as `configuration.public_key`
 ///

client/examples/tutorial.rs

@@ -93,16 +93,13 @@ fn domain_registration_test(config: &Configuration) -> Result<(), Error> {
 
 fn account_definition_test() -> Result<(), Error> {
     // #region account_definition_comparison
-    use iroha_data_model::{account::Id as AccountIdStruct, prelude::AccountId};
+    use iroha_data_model::prelude::AccountId;
 
-    // Create an `iroha_data_model::account::Id` instance
+    // Create an `iroha_data_model::AccountId` instance
     // with a DomainId instance and a Domain ID for an account
-    let longhand_account_id = AccountIdStruct {
-        name: "white_rabbit".parse()?,
-        domain_id: "looking_glass".parse()?,
-    };
+    let longhand_account_id = AccountId::new("white_rabbit".parse()?, "looking_glass".parse()?);
     let account_id: AccountId = "white_rabbit@looking_glass"
-        .parse::<AccountIdStruct>()
+        .parse()
         .expect("Valid, because the string contains no whitespace, has a single '@' character and is not empty after");
 
     // Check that two ways to define an account match
@@ -119,7 +116,6 @@ fn account_registration_test(config: &Configuration) -> Result<(), Error> {
     use iroha_client::client::Client;
     use iroha_crypto::KeyPair;
     use iroha_data_model::{
-        account::Id as AccountIdStruct,
         metadata::UnlimitedMetadata,
         prelude::{Account, AccountId, Instruction, RegisterBox},
     };
@@ -129,10 +125,9 @@ fn account_registration_test(config: &Configuration) -> Result<(), Error> {
     let iroha_client: Client = Client::new(&config)?;
 
     // #region register_account_create
-    // Create an AccountId instance by providing
-    // the account and domain name
+    // Create an AccountId instance by providing the account and domain name
     let account_id: AccountId = "white_rabbit@looking_glass"
-        .parse::<AccountIdStruct>()
+        .parse()
         .expect("Valid, because the string contains no whitespace, has a single '@' character and is not empty after");
     // #endregion register_account_create
 
@@ -169,11 +164,8 @@ fn asset_registration_test(config: &Configuration) -> Result<(), Error> {
     use std::str::FromStr as _;
 
     use iroha_client::client::Client;
-    use iroha_data_model::{
-        account::Id as AccountIdStruct,
-        prelude::{
-            AccountId, AssetDefinition, AssetDefinitionId, AssetId, IdBox, MintBox, RegisterBox,
-        },
+    use iroha_data_model::prelude::{
+        AccountId, AssetDefinition, AssetDefinitionId, AssetId, IdBox, MintBox, RegisterBox,
     };
     // #endregion register_asset_crates
 
@@ -197,7 +189,7 @@ fn asset_registration_test(config: &Configuration) -> Result<(), Error> {
 
     // Create an account using the previously defined asset
     let account_id: AccountId = "white_rabbit@looking_glass"
-        .parse::<AccountIdStruct>()
+        .parse()
         .expect("Valid, because the string contains no whitespace, has a single '@' character and is not empty after");
 
     // #region register_asset_mint_submit

config/src/iroha.rs

@@ -111,7 +111,7 @@ impl ConfigurationProxy {
             // former and overwritten silently in case of difference
             if let Some(torii_proxy) = &mut self.torii {
                 if sumeragi_proxy.peer_id.is_none() {
-                    sumeragi_proxy.peer_id = Some(iroha_data_model::peer::Id::new(
+                    sumeragi_proxy.peer_id = Some(iroha_data_model::peer::PeerId::new(
                         &torii_proxy.p2p_addr.clone().ok_or_else(|| {
                             eyre::eyre!("Torii `p2p_addr` field has `None` value")
                         })?,

core/src/smartcontracts/wasm.rs

@@ -617,7 +617,7 @@ impl<'wrld> Runtime<'wrld> {
         &self,
         wsv: &WorldStateView,
         authority: &<Account as Identifiable>::Id,
-        id: &validator::Id,
+        id: &validator::ValidatorId,
         module: &wasmtime::Module,
         operation: &permission::validator::NeedsPermissionBox,
     ) -> Result<permission::validator::Verdict> {

core/src/validator.rs

@@ -5,7 +5,7 @@ use core::fmt::{self, Debug, Formatter};
 use dashmap::DashMap;
 use iroha_data_model::{
     permission::validator::{
-        DenialReason, Id, NeedsPermission as _, NeedsPermissionBox, Type, Validator,
+        DenialReason, NeedsPermission as _, NeedsPermissionBox, Type, Validator, ValidatorId,
     },
     prelude::Account,
     Identifiable,
@@ -47,8 +47,8 @@ pub type Result<T, E = Error> = core::result::Result<T, E>;
 /// [`Deny`](iroha_data_model::permission::validator::Verdict::Deny) verdict.
 #[derive(Clone)]
 pub struct Chain {
-    all_validators: DashMap<Id, LoadedValidator>,
-    concrete_type_validators: DashMap<Type, Vec<Id>>,
+    all_validators: DashMap<ValidatorId, LoadedValidator>,
+    concrete_type_validators: DashMap<Type, Vec<ValidatorId>>,
     /// Engine for WASM [`Runtime`](wasm::Runtime) to execute validators.
     engine: wasmtime::Engine,
 }
@@ -79,7 +79,7 @@ impl Default for Chain {
 /// [`validate()`](Chain::validate) step.
 #[derive(Clone)]
 struct LoadedValidator {
-    id: Id,
+    id: ValidatorId,
     validator_type: Type,
     module: wasmtime::Module,
 }
@@ -143,7 +143,7 @@ impl Chain {
     /// Return `true` if the validator was removed
     /// and `false` if no validator with the given id was found.
     #[allow(clippy::expect_used)]
-    pub fn remove_validator(&self, id: &Id) -> bool {
+    pub fn remove_validator(&self, id: &ValidatorId) -> bool {
         self.all_validators.get(id).map_or(false, |entry| {
             let type_ = &entry.validator_type;
 
@@ -207,7 +207,7 @@ impl Chain {
         runtime: &wasm::Runtime,
         wsv: &WorldStateView,
         authority: &<Account as Identifiable>::Id,
-        validator_id: &iroha_data_model::permission::validator::Id,
+        validator_id: &iroha_data_model::permission::validator::ValidatorId,
         operation: &NeedsPermissionBox,
     ) -> Result<()> {
         let validator = self.all_validators.get(validator_id).expect(

data_model/derive/src/api.rs

@@ -10,13 +10,13 @@ pub fn process_item(mut input: syn::DeriveInput) -> TokenStream {
     }
 
     let non_transparent_item = quote! {
-        #[cfg(not(feature = "transparent_api"))]
+        #[cfg(all(not(test), not(feature = "transparent_api")))]
         #input
     };
 
     input.vis = parse_quote! {pub};
     let transparent_item = quote! {
-        #[cfg(feature = "transparent_api")]
+        #[cfg(any(test, feature = "transparent_api"))]
         #input
     };
 
@@ -45,11 +45,11 @@ fn process_pub_item(input: syn::DeriveInput) -> TokenStream {
                     }
 
                     quote! {
-                        #[cfg(feature = "transparent_api")]
+                        #[cfg(any(test, feature = "transparent_api"))]
                         #(#field_attrs)*
                         pub #field_name: #field_ty,
 
-                        #[cfg(not(feature = "transparent_api"))]
+                        #[cfg(all(not(test), not(feature = "transparent_api")))]
                         #(#field_attrs)*
                         pub(crate) #field_name: #field_ty,
                     }
@@ -73,11 +73,11 @@ fn process_pub_item(input: syn::DeriveInput) -> TokenStream {
                     }
 
                     quote! {
-                        #[cfg(feature = "transparent_api")]
+                        #[cfg(any(test, feature = "transparent_api"))]
                         #(#field_attrs)*
                         pub #field_ty,
 
-                        #[cfg(not(feature = "transparent_api"))]
+                        #[cfg(all(not(test), not(feature = "transparent_api")))]
                         #(#field_attrs)*
                         pub(crate) #field_ty,
                     }
@@ -120,11 +120,11 @@ fn process_pub_item(input: syn::DeriveInput) -> TokenStream {
 
                 quote! {
                     #(#field_attrs)*
-                    #[cfg(feature = "transparent_api")]
+                    #[cfg(any(test, feature = "transparent_api"))]
                     pub #field_name: #field_ty,
 
                     #(#field_attrs)*
-                    #[cfg(not(feature = "transparent_api"))]
+                    #[cfg(all(not(test), not(feature = "transparent_api")))]
                     pub(crate) #field_name: #field_ty,
                 }
             });

data_model/derive/src/lib.rs

@@ -39,28 +39,35 @@ impl syn::parse::Parse for Items {
 /// use iroha_data_model_derive::model;
 ///
 /// model! {
-///     struct DataModel {
+///     pub struct DataModel1 {
+///        pub item1: u32,
+///        item2: u64
+///     }
+///
+///     pub(crate) struct DataModel2 {
 ///        pub item1: u32,
 ///        item2: u64
 ///     }
 /// }
 ///
 /// /* will produce:
-/// #[cfg(feature = "transparent_api")]
-/// pub struct DataModel {
-///    #[cfg(feature = "transparent_api")]
+/// pub struct DataModel1 {
+///    #[cfg(any(test, feature = "transparent_api"))]
 ///    pub item1: u32,
-///    #[cfg(not(feature = "transparent_api"))]
+///    #[cfg(all(not(test), not(feature = "transparent_api")))]
 ///    pub(crate) item1: u32,
 ///    item2: u64
 /// }
 ///
-/// #[cfg(not(feature = "transparent_api"))]
-/// struct DataModel {
-///    #[cfg(feature = "transparent_api")]
+/// #[cfg(all(not(test), not(feature = "transparent_api")))]
+/// pub struct DataModel2 {
+///    pub item1: u32,
+///    item2: u64
+/// }
+///
+/// #[cfg(any(test, feature = "transparent_api"))]
+/// struct DataModel2 {
 ///    pub item1: u32,
-///    #[cfg(not(feature = "transparent_api"))]
-///    pub(crate) item1: u32,
 ///    item2: u64
 /// }
 /// */

data_model/derive/src/partially_tagged.rs

@@ -152,7 +152,6 @@ pub fn impl_partially_tagged_serialize(enum_: &PartiallyTaggedEnum) -> TokenStre
 
                 #[derive(::serde::Serialize)]
                 #[serde(untagged)]
-                #[allow(variant_size_differences)]
                 enum SerializeHelper<'re> {
                     #(
                         #(
@@ -215,7 +214,6 @@ pub fn impl_partially_tagged_deserialize(enum_: &PartiallyTaggedEnum) -> TokenSt
 
                 #[derive(::serde::Deserialize)]
                 #[serde(untagged)]
-                #[allow(variant_size_differences)]
                 enum DeserializeHelper {
                     #(
                         #(

data_model/derive/tests/ui_fail/transparent_api_private_field.rs

@@ -1,4 +1,4 @@
-use iroha_data_model::account::Id as AccountId;
+use iroha_data_model::account::AccountId;
 
 fn main() {
     let account_id: AccountId = "alice@wonderland".parse().expect("Valid account id");

data_model/derive/tests/ui_fail/transparent_api_private_field.stderr

@@ -1,4 +1,4 @@
-error[E0616]: field `name` of struct `iroha_data_model::account::Id` is private
+error[E0616]: field `name` of struct `iroha_data_model::account::AccountId` is private
  --> tests/ui_fail/transparent_api_private_field.rs:5:35
   |
 5 |     println!("ID: {}", account_id.name);

data_model/src/account.rs

@@ -20,8 +20,6 @@ use parity_scale_codec::{Decode, Encode};
 use serde::{Deserialize, Serialize};
 use serde_with::{DeserializeFromStr, SerializeDisplay};
 
-#[cfg(feature = "transparent_api")]
-use crate::Registrable;
 use crate::{
     asset::{
         prelude::{Asset, AssetId},
@@ -58,15 +56,15 @@ model! {
     /// # Examples
     ///
     /// ```rust
-    /// use iroha_data_model::account::Id;
+    /// use iroha_data_model::account::AccountId;
     ///
-    /// let id = "user@company".parse::<Id>().expect("Valid");
+    /// let id = "user@company".parse::<AccountId>().expect("Valid");
     /// ```
     #[derive(Debug, Display, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Constructor, Getters, Decode, Encode, DeserializeFromStr, SerializeDisplay, IntoSchema)]
     #[display(fmt = "{name}@{domain_id}")]
     #[getset(get = "pub")]
     #[ffi_type]
-    pub struct Id {
+    pub struct AccountId {
         /// [`Account`]'s name.
         pub name: Name,
         /// [`Account`]'s [`Domain`](`crate::domain::Domain`) id.
@@ -80,7 +78,7 @@ model! {
     #[ffi_type]
     pub struct Account {
         /// An Identification of the [`Account`].
-        pub id: Id,
+        pub id: AccountId,
         /// Assets in this [`Account`].
         pub assets: AssetsMap,
         /// [`Account`]'s signatories.
@@ -116,14 +114,14 @@ model! {
     pub struct SignatureCheckCondition(pub EvaluatesTo<bool>);
 }
 
-impl Id {
-    #[cfg(feature = "transparent_api")]
+impl AccountId {
+    #[cfg(any(test, feature = "transparent_api"))]
     const GENESIS_ACCOUNT_NAME: &str = "genesis";
 
     /// Construct [`Id`] of the genesis account.
     #[inline]
     #[must_use]
-    #[cfg(feature = "transparent_api")]
+    #[cfg(any(test, feature = "transparent_api"))]
     pub fn genesis() -> Self {
         Self {
             name: Self::GENESIS_ACCOUNT_NAME.parse().expect("Valid"),
@@ -180,7 +178,7 @@ impl Account {
     }
 }
 
-#[cfg(feature = "transparent_api")]
+#[cfg(any(test, feature = "transparent_api"))]
 impl Account {
     /// Add [`Asset`] into the [`Account`] returning previous asset stored under the same id
     #[inline]
@@ -282,8 +280,8 @@ impl Default for SignatureCheckCondition {
     }
 }
 
-#[cfg(feature = "transparent_api")]
-impl Registrable for NewAccount {
+#[cfg(any(test, feature = "transparent_api"))]
+impl crate::Registrable for NewAccount {
     type Target = Account;
 
     #[must_use]
@@ -326,7 +324,7 @@ impl FromIterator<Account> for crate::Value {
 }
 
 /// Account Identification is represented by `name@domain_name` string.
-impl FromStr for Id {
+impl FromStr for AccountId {
     type Err = ParseError;
 
     fn from_str(string: &str) -> Result<Self, Self::Err> {
@@ -335,7 +333,7 @@ impl FromStr for Id {
             Some(("", _)) => Err(ParseError {
                 reason: "`AccountId` cannot be empty",
             }),
-            Some((name, domain_id)) if !name.is_empty() && !domain_id.is_empty() => Ok(Id {
+            Some((name, domain_id)) if !name.is_empty() && !domain_id.is_empty() => Ok(AccountId {
                 name: name.parse()?,
                 domain_id: domain_id.parse()?,
             }),
@@ -348,5 +346,5 @@ impl FromStr for Id {
 
 /// The prelude re-exports most commonly used traits, structs and macros from this crate.
 pub mod prelude {
-    pub use super::{Account, Id as AccountId, SignatureCheckCondition};
+    pub use super::{Account, AccountId, SignatureCheckCondition};
 }