fix(iota-keys): add alias to AccountKeystore::import_from_mnemonic (

#2147)

crates/iota-keys/src/keystore.rs

@@ -131,14 +131,15 @@ pub trait AccountKeystore: Send + Sync {
         &mut self,
         phrase: &str,
         key_scheme: SignatureScheme,
+        alias: Option<String>,
         derivation_path: Option<DerivationPath>,
     ) -> Result<IotaAddress, anyhow::Error> {
         let mnemonic = Mnemonic::from_phrase(phrase, Language::English)
             .map_err(|e| anyhow::anyhow!("Invalid mnemonic phrase: {:?}", e))?;
         let seed = Seed::new(&mnemonic, "");
         match derive_key_pair_from_path(seed.as_bytes(), derivation_path, &key_scheme) {
             Ok((address, kp)) => {
-                self.add_key(None, kp)?;
+                self.add_key(alias, kp)?;
                 Ok(address)
             }
             Err(e) => Err(anyhow!("error getting keypair {:?}", e)),

crates/iota-keys/tests/tests.rs

@@ -204,7 +204,7 @@ fn mnemonic_test() {
     let keystore_path_2 = temp_dir.path().join("iota2.keystore");
     let mut keystore2 = Keystore::from(FileBasedKeystore::new(&keystore_path_2).unwrap());
     let imported_address = keystore2
-        .import_from_mnemonic(&phrase, SignatureScheme::ED25519, None)
+        .import_from_mnemonic(&phrase, SignatureScheme::ED25519, None, None)
         .unwrap();
     assert_eq!(scheme.flag(), Ed25519IotaSignature::SCHEME.flag());
     assert_eq!(address, imported_address);
@@ -224,7 +224,7 @@ fn iota_wallet_address_mnemonic_test() -> Result<(), anyhow::Error> {
     let mut keystore = Keystore::from(FileBasedKeystore::new(&keystore_path).unwrap());
 
     keystore
-        .import_from_mnemonic(phrase, SignatureScheme::ED25519, None)
+        .import_from_mnemonic(phrase, SignatureScheme::ED25519, None, None)
         .unwrap();
 
     let pubkey = keystore.keys()[0].clone();

crates/iota-sdk/tests/tests.rs

@@ -18,7 +18,7 @@ fn mnemonic_test() {
     let keystore_path_2 = temp_dir.path().join("iota2.keystore");
     let mut keystore2 = Keystore::from(FileBasedKeystore::new(&keystore_path_2).unwrap());
     let imported_address = keystore2
-        .import_from_mnemonic(&phrase, SignatureScheme::ED25519, None)
+        .import_from_mnemonic(&phrase, SignatureScheme::ED25519, None, None)
         .unwrap();
     assert_eq!(scheme.flag(), Ed25519IotaSignature::SCHEME.flag());
     assert_eq!(address, imported_address);

crates/iota/src/keytool.rs

@@ -617,6 +617,7 @@ impl KeyToolCommand {
                         let iota_address = keystore.import_from_mnemonic(
                             &input_string,
                             key_scheme,
+                            None,
                             derivation_path,
                         )?;
                         let ikp = keystore.get_key(&iota_address)?;

docs/examples/rust/src/utils.rs

@@ -56,7 +56,7 @@ pub async fn fund_address(
     recipient: IotaAddress,
 ) -> Result<(), anyhow::Error> {
     // Derive the address of the sponsor.
-    let sponsor = keystore.import_from_mnemonic(SPONSOR_ADDRESS_MNEMONIC, ED25519, None)?;
+    let sponsor = keystore.import_from_mnemonic(SPONSOR_ADDRESS_MNEMONIC, ED25519, None, None)?;
 
     println!("Sponsor address: {sponsor:?}");
 

docs/examples/rust/stardust/address-unlock-condition.rs

@@ -50,8 +50,12 @@ async fn main() -> Result<(), anyhow::Error> {
     println!("{derivation_path:?}");
 
     // Derive the address of the first account and set it as default
-    let sender =
-        keystore.import_from_mnemonic(MAIN_ADDRESS_MNEMONIC, ED25519, Some(derivation_path))?;
+    let sender = keystore.import_from_mnemonic(
+        MAIN_ADDRESS_MNEMONIC,
+        ED25519,
+        None,
+        Some(derivation_path),
+    )?;
 
     println!("Sender address - {sender:?}");
 

docs/examples/rust/stardust/alias-migration.rs

@@ -40,7 +40,7 @@ async fn main() -> Result<(), anyhow::Error> {
     let mut keystore = setup_keystore()?;
 
     // Derive the address of the first account and set it as default
-    let sender = keystore.import_from_mnemonic(MAIN_ADDRESS_MNEMONIC, ED25519, None)?;
+    let sender = keystore.import_from_mnemonic(MAIN_ADDRESS_MNEMONIC, ED25519, None, None)?;
 
     println!("{sender:?}");
 

docs/examples/rust/stardust/alias-output-claim.rs

@@ -39,7 +39,7 @@ async fn main() -> Result<(), anyhow::Error> {
     let mut keystore = setup_keystore()?;
 
     // Derive the address of the first account and set it as default.
-    let sender = keystore.import_from_mnemonic(MAIN_ADDRESS_MNEMONIC, ED25519, None)?;
+    let sender = keystore.import_from_mnemonic(MAIN_ADDRESS_MNEMONIC, ED25519, None, None)?;
 
     println!("Sender address: {sender:?}");
 

docs/examples/rust/stardust/basic-output-claim.rs

@@ -39,7 +39,7 @@ async fn main() -> Result<(), anyhow::Error> {
     let mut keystore = setup_keystore()?;
 
     // Derive the address of the first account and set it as default
-    let sender = keystore.import_from_mnemonic(MAIN_ADDRESS_MNEMONIC, ED25519, None)?;
+    let sender = keystore.import_from_mnemonic(MAIN_ADDRESS_MNEMONIC, ED25519, None, None)?;
 
     println!("Sender address: {sender:?}");
 

docs/examples/rust/stardust/foundry-output-claim.rs

@@ -40,7 +40,7 @@ async fn main() -> Result<(), anyhow::Error> {
     let mut keystore = setup_keystore()?;
 
     // Derive the address of the first account and set it as default.
-    let sender = keystore.import_from_mnemonic(MAIN_ADDRESS_MNEMONIC, ED25519, None)?;
+    let sender = keystore.import_from_mnemonic(MAIN_ADDRESS_MNEMONIC, ED25519, None, None)?;
 
     println!("Sender address: {sender:?}");
 

docs/examples/rust/stardust/nft-migration.rs

@@ -36,7 +36,7 @@ async fn main() -> Result<(), anyhow::Error> {
     let mut keystore = setup_keystore()?;
 
     // Derive the address of the first account and set it as default
-    let sender = keystore.import_from_mnemonic(MAIN_ADDRESS_MNEMONIC, ED25519, None)?;
+    let sender = keystore.import_from_mnemonic(MAIN_ADDRESS_MNEMONIC, ED25519, None, None)?;
 
     println!("{sender:?}");
 

docs/examples/rust/stardust/nft-output-claim.rs

@@ -39,7 +39,7 @@ async fn main() -> Result<(), anyhow::Error> {
     let mut keystore = setup_keystore()?;
 
     // Derive the address of the first account and set it as default
-    let sender = keystore.import_from_mnemonic(MAIN_ADDRESS_MNEMONIC, ED25519, None)?;
+    let sender = keystore.import_from_mnemonic(MAIN_ADDRESS_MNEMONIC, ED25519, None, None)?;
 
     println!("{sender:?}");
 

docs/examples/rust/stardust/shimmer-self-sponsor.rs

@@ -53,6 +53,7 @@ async fn main() -> Result<(), anyhow::Error> {
     let sponsor = keystore.import_from_mnemonic(
         MAIN_ADDRESS_MNEMONIC,
         ED25519,
+        None,
         Some(sponsor_derivation_path),
     )?;
     println!("Sponsor address: {sponsor:?}");
@@ -61,6 +62,7 @@ async fn main() -> Result<(), anyhow::Error> {
     let sender = keystore.import_from_mnemonic(
         MAIN_ADDRESS_MNEMONIC,
         ED25519,
+        None,
         Some(sender_derivation_path),
     )?;
     println!("Sender address: {sender:?}");