feat!: rename types for iota PR iotaledger/iota#3499

Thoralf-M · Thoralf-M · commit 1cfabb7cb070 · 2024-10-23T13:13:16.000+02:00
diff --git a/crates/iota-rust-sdk/src/types/mod.rs b/crates/iota-rust-sdk/src/types/mod.rs
@@ -54,14 +54,14 @@ pub use object_id::ObjectId;
 #[cfg_attr(doc_cfg, doc(cfg(feature = "serde")))]
 pub(crate) use transaction::SignedTransactionWithIntentMessage;
 pub use transaction::{
-    ActiveJwk, Argument, AuthenticatorStateExpire, AuthenticatorStateUpdate, CancelledTransaction,
-    ChangeEpoch, Command, ConsensusCommitPrologueV1, ConsensusDeterminedVersionAssignments,
-    EndOfEpochTransactionKind, GasPayment, GenesisTransaction, InputArgument, MakeMoveVector,
-    MergeCoins, MoveCall, ProgrammableTransaction, Publish, RandomnessStateUpdate,
-    SignedTransaction, SplitCoins, SystemPackage, Transaction, TransactionExpiration,
-    TransactionKind, TransferObjects, UnresolvedGasPayment, UnresolvedInputArgument,
-    UnresolvedObjectReference, UnresolvedProgrammableTransaction, UnresolvedTransaction, Upgrade,
-    VersionAssignment,
+    ActiveJwk, Argument, AuthenticatorStateExpire, AuthenticatorStateUpdateV1,
+    CancelledTransaction, ChangeEpoch, Command, ConsensusCommitPrologueV1,
+    ConsensusDeterminedVersionAssignments, EndOfEpochTransactionKind, GasPayment,
+    GenesisTransaction, InputArgument, MakeMoveVector, MergeCoins, MoveCall,
+    ProgrammableTransaction, Publish, RandomnessStateUpdate, SignedTransaction, SplitCoins,
+    SystemPackage, Transaction, TransactionExpiration, TransactionKind, TransferObjects,
+    UnresolvedGasPayment, UnresolvedInputArgument, UnresolvedObjectReference,
+    UnresolvedProgrammableTransaction, UnresolvedTransaction, Upgrade, VersionAssignment,
 };
 pub use type_tag::{Identifier, StructTag, TypeParseError, TypeTag};
 
diff --git a/crates/iota-rust-sdk/src/types/object.rs b/crates/iota-rust-sdk/src/types/object.rs
@@ -360,8 +360,8 @@ mod serialization {
         /// A IOTA coin (i.e., `0x2::coin::Coin<0x2::iota::IOTA>`)
         GasCoin,
         /// A record of a staked IOTA coin (i.e.,
-        /// `0x3::staking_pool::StakedIota`)
-        StakedIota,
+        /// `0x3::staking_pool::StakedIotaV1`)
+        StakedIotaV1,
         /// A non-IOTA coin type (i.e., `0x2::coin::Coin<T> where T !=
         /// 0x2::iota::IOTA`)
         Coin(TypeTag),
@@ -378,8 +378,8 @@ mod serialization {
         /// A IOTA coin (i.e., `0x2::coin::Coin<0x2::iota::IOTA>`)
         GasCoin,
         /// A record of a staked IOTA coin (i.e.,
-        /// `0x3::staking_pool::StakedIota`)
-        StakedIota,
+        /// `0x3::staking_pool::StakedIotaV1`)
+        StakedIotaV1,
         /// A non-IOTA coin type (i.e., `0x2::coin::Coin<T> where T !=
         /// 0x2::iota::IOTA`)
         Coin(&'a TypeTag),
@@ -393,7 +393,7 @@ mod serialization {
             match self {
                 MoveStructType::Other(tag) => tag,
                 MoveStructType::GasCoin => StructTag::gas_coin(),
-                MoveStructType::StakedIota => StructTag::staked_iota(),
+                MoveStructType::StakedIotaV1 => StructTag::staked_iota(),
                 MoveStructType::Coin(type_tag) => StructTag::coin(type_tag),
             }
         }
@@ -429,10 +429,10 @@ mod serialization {
                 Self::Coin(coin_type)
             } else if address == &Address::THREE
                 && module == "staking_pool"
-                && name == "StakedIota"
+                && name == "StakedIotaV1"
                 && type_params.is_empty()
             {
-                Self::StakedIota
+                Self::StakedIotaV1
             } else {
                 Self::Other(s)
             }
diff --git a/crates/iota-rust-sdk/src/types/serialization_proptests.rs b/crates/iota-rust-sdk/src/types/serialization_proptests.rs
@@ -152,7 +152,7 @@ serialization_test!(ObjectId);
 serialization_test!(ActiveJwk);
 serialization_test!(Argument);
 serialization_test!(AuthenticatorStateExpire);
-serialization_test!(AuthenticatorStateUpdate);
+serialization_test!(AuthenticatorStateUpdateV1);
 serialization_test!(ChangeEpoch);
 serialization_test!(Command);
 serialization_test!(ConsensusCommitPrologueV1);
diff --git a/crates/iota-rust-sdk/src/types/transaction/mod.rs b/crates/iota-rust-sdk/src/types/transaction/mod.rs
@@ -113,7 +113,7 @@ pub enum TransactionKind {
     /// only signs internally during epoch changes.
     Genesis(GenesisTransaction),
     ConsensusCommitPrologueV1(ConsensusCommitPrologueV1),
-    AuthenticatorStateUpdate(AuthenticatorStateUpdate),
+    AuthenticatorStateUpdateV1(AuthenticatorStateUpdateV1),
 
     /// EndOfEpochTransaction replaces ChangeEpoch with a list of transactions
     /// that are allowed to run at the end of the epoch.
@@ -169,7 +169,7 @@ pub struct AuthenticatorStateExpire {
 )]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 #[cfg_attr(test, derive(test_strategy::Arbitrary))]
-pub struct AuthenticatorStateUpdate {
+pub struct AuthenticatorStateUpdateV1 {
     /// Epoch of the authenticator state update transaction
     #[cfg_attr(feature = "serde", serde(with = "crate::_serde::ReadableDisplay"))]
     #[cfg_attr(feature = "schemars", schemars(with = "crate::_schemars::U64"))]
@@ -184,8 +184,8 @@ pub struct AuthenticatorStateUpdate {
     #[cfg_attr(feature = "serde", serde(with = "crate::_serde::ReadableDisplay"))]
     #[cfg_attr(feature = "schemars", schemars(with = "crate::_schemars::U64"))]
     pub authenticator_obj_initial_shared_version: u64,
-    // to version this struct, do not add new fields. Instead, add a AuthenticatorStateUpdateV2 to
-    // TransactionKind.
+    // to version this struct, do not add new fields. Instead, add a AuthenticatorStateUpdateV2
+    // to TransactionKind.
 }
 
 #[derive(Clone, Debug, PartialEq, Eq)]
diff --git a/crates/iota-rust-sdk/src/types/transaction/serialization.rs b/crates/iota-rust-sdk/src/types/transaction/serialization.rs
@@ -124,7 +124,7 @@ mod transaction {
 mod transaction_kind {
     use super::*;
     use crate::types::transaction::{
-        AuthenticatorStateUpdate, ConsensusCommitPrologueV1, EndOfEpochTransactionKind,
+        AuthenticatorStateUpdateV1, ConsensusCommitPrologueV1, EndOfEpochTransactionKind,
         GenesisTransaction, ProgrammableTransaction, RandomnessStateUpdate, TransactionKind,
     };
 
@@ -134,7 +134,7 @@ mod transaction_kind {
         ProgrammableTransaction(&'a ProgrammableTransaction),
         Genesis(&'a GenesisTransaction),
         ConsensusCommitPrologueV1(&'a ConsensusCommitPrologueV1),
-        AuthenticatorStateUpdate(&'a AuthenticatorStateUpdate),
+        AuthenticatorStateUpdateV1(&'a AuthenticatorStateUpdateV1),
         EndOfEpoch {
             commands: &'a Vec<EndOfEpochTransactionKind>,
         },
@@ -149,7 +149,7 @@ mod transaction_kind {
         ProgrammableTransaction(ProgrammableTransaction),
         Genesis(GenesisTransaction),
         ConsensusCommitPrologueV1(ConsensusCommitPrologueV1),
-        AuthenticatorStateUpdate(AuthenticatorStateUpdate),
+        AuthenticatorStateUpdateV1(AuthenticatorStateUpdateV1),
         EndOfEpoch {
             commands: Vec<EndOfEpochTransactionKind>,
         },
@@ -172,7 +172,7 @@ mod transaction_kind {
         ProgrammableTransaction(&'a ProgrammableTransaction),
         Genesis(&'a GenesisTransaction),
         ConsensusCommitPrologueV1(&'a ConsensusCommitPrologueV1),
-        AuthenticatorStateUpdate(&'a AuthenticatorStateUpdate),
+        AuthenticatorStateUpdateV1(&'a AuthenticatorStateUpdateV1),
         EndOfEpoch(&'a Vec<EndOfEpochTransactionKind>),
         RandomnessStateUpdate(&'a RandomnessStateUpdate),
     }
@@ -181,7 +181,7 @@ mod transaction_kind {
         ProgrammableTransaction(ProgrammableTransaction),
         Genesis(GenesisTransaction),
         ConsensusCommitPrologueV1(ConsensusCommitPrologueV1),
-        AuthenticatorStateUpdate(AuthenticatorStateUpdate),
+        AuthenticatorStateUpdateV1(AuthenticatorStateUpdateV1),
         EndOfEpoch(Vec<EndOfEpochTransactionKind>),
         RandomnessStateUpdate(RandomnessStateUpdate),
     }
@@ -200,8 +200,8 @@ mod transaction_kind {
                     Self::ConsensusCommitPrologueV1(k) => {
                         ReadableTransactionKindRef::ConsensusCommitPrologueV1(k)
                     }
-                    Self::AuthenticatorStateUpdate(k) => {
-                        ReadableTransactionKindRef::AuthenticatorStateUpdate(k)
+                    Self::AuthenticatorStateUpdateV1(k) => {
+                        ReadableTransactionKindRef::AuthenticatorStateUpdateV1(k)
                     }
                     Self::EndOfEpoch(commands) => {
                         ReadableTransactionKindRef::EndOfEpoch { commands }
@@ -220,8 +220,8 @@ mod transaction_kind {
                     Self::ConsensusCommitPrologueV1(k) => {
                         BinaryTransactionKindRef::ConsensusCommitPrologueV1(k)
                     }
-                    Self::AuthenticatorStateUpdate(k) => {
-                        BinaryTransactionKindRef::AuthenticatorStateUpdate(k)
+                    Self::AuthenticatorStateUpdateV1(k) => {
+                        BinaryTransactionKindRef::AuthenticatorStateUpdateV1(k)
                     }
                     Self::EndOfEpoch(k) => BinaryTransactionKindRef::EndOfEpoch(k),
                     Self::RandomnessStateUpdate(k) => {
@@ -247,8 +247,8 @@ mod transaction_kind {
                     ReadableTransactionKind::ConsensusCommitPrologueV1(k) => {
                         Self::ConsensusCommitPrologueV1(k)
                     }
-                    ReadableTransactionKind::AuthenticatorStateUpdate(k) => {
-                        Self::AuthenticatorStateUpdate(k)
+                    ReadableTransactionKind::AuthenticatorStateUpdateV1(k) => {
+                        Self::AuthenticatorStateUpdateV1(k)
                     }
                     ReadableTransactionKind::EndOfEpoch { commands } => Self::EndOfEpoch(commands),
                     ReadableTransactionKind::RandomnessStateUpdate(k) => {
@@ -264,8 +264,8 @@ mod transaction_kind {
                     BinaryTransactionKind::ConsensusCommitPrologueV1(k) => {
                         Self::ConsensusCommitPrologueV1(k)
                     }
-                    BinaryTransactionKind::AuthenticatorStateUpdate(k) => {
-                        Self::AuthenticatorStateUpdate(k)
+                    BinaryTransactionKind::AuthenticatorStateUpdateV1(k) => {
+                        Self::AuthenticatorStateUpdateV1(k)
                     }
                     BinaryTransactionKind::EndOfEpoch(k) => Self::EndOfEpoch(k),
                     BinaryTransactionKind::RandomnessStateUpdate(k) => {
diff --git a/crates/iota-rust-sdk/src/types/type_tag/mod.rs b/crates/iota-rust-sdk/src/types/type_tag/mod.rs
@@ -149,7 +149,7 @@ impl StructTag {
         Self {
             address: Address::THREE,
             module: Identifier::new("staking_pool").unwrap(),
-            name: Identifier::new("StakedIota").unwrap(),
+            name: Identifier::new("StakedIotaV1").unwrap(),
             type_params: vec![],
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -149,7 +149,7 @@ impl StructTag {`
`149`	`149`	`Self {`
`150`	`150`	`address: Address::THREE,`
`151`	`151`	`module: Identifier::new("staking_pool").unwrap(),`
`152`		`- name: Identifier::new("StakedIota").unwrap(),`
	`152`	`+ name: Identifier::new("StakedIotaV1").unwrap(),`
`153`	`153`	`type_params: vec![],`
`154`	`154`	`}`
`155`	`155`	`}`