Add get_or_create_account (#971)

* Add `get_or_create_account`

* clippy

* changelog

sdk/CHANGELOG.md

@@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- `Wallet::get_or_create_account` convenience method;
 - `Output::kind_str()` method;
 
 ### Changed

sdk/examples/wallet/accounts.rs

@@ -17,7 +17,7 @@ use iota_sdk::{
         secret::{mnemonic::MnemonicSecretManager, SecretManager},
         utils::request_funds_from_faucet,
     },
-    wallet::{Account, ClientOptions, Result, Wallet},
+    wallet::{ClientOptions, Result, Wallet},
 };
 
 // The number of addresses to generate
@@ -41,11 +41,11 @@ async fn main() -> Result<()> {
         .await?;
 
     // Get or create first account
-    let _ = get_or_create_account(&wallet, "Alice").await?;
+    let _ = wallet.get_or_create_account("Alice").await?;
 
     // Get or create second account
     let alias2 = "Bob";
-    let account2 = get_or_create_account(&wallet, alias2).await?;
+    let account2 = wallet.get_or_create_account("Alice").await?;
 
     let accounts = wallet.get_accounts().await?;
     println!("WALLET ACCOUNTS:");
@@ -94,12 +94,3 @@ async fn main() -> Result<()> {
 
     Ok(())
 }
-
-async fn get_or_create_account(wallet: &Wallet, alias: &str) -> Result<Account> {
-    Ok(if let Ok(account) = wallet.get_account(alias).await {
-        account
-    } else {
-        println!("Creating account '{alias}'");
-        wallet.create_account().with_alias(alias).finish().await?
-    })
-}

sdk/examples/wallet/background_syncing.rs

@@ -34,13 +34,7 @@ async fn main() -> Result<()> {
         .await?;
 
     // Get or create new account
-    let alias = "Alice";
-    let account = if let Ok(account) = wallet.get_account(alias).await {
-        account
-    } else {
-        println!("Creating account '{alias}'");
-        wallet.create_account().with_alias(alias).finish().await?
-    };
+    let account = wallet.get_or_create_account("Alice").await?;
     let addresses = account.addresses().await?;
 
     // Manually sync to ensure we have the correct funds to start with

sdk/examples/wallet/events.rs

@@ -50,13 +50,7 @@ async fn main() -> Result<()> {
         .await;
 
     // Get or create an account
-    let alias = "Alice";
-    let account = if let Ok(account) = wallet.get_account(alias).await {
-        account
-    } else {
-        println!("Creating account '{alias}'");
-        wallet.create_account().with_alias(alias).finish().await?
-    };
+    let account = wallet.get_or_create_account("Alice").await?;
 
     let balance = account.sync(None).await?;
     println!("Balance BEFORE:\n{:#?}", balance.base_coin());

sdk/examples/wallet/ledger_nano.rs

@@ -49,12 +49,7 @@ async fn main() -> Result<()> {
     println!("{:?}", wallet.get_ledger_nano_status().await?);
 
     // Get or create a new account
-    let account = if let Ok(account) = wallet.get_account(ACCOUNT_ALIAS).await {
-        account
-    } else {
-        println!("Creating account '{ACCOUNT_ALIAS}'");
-        wallet.create_account().with_alias(ACCOUNT_ALIAS).finish().await?
-    };
+    let account = wallet.get_or_create_account(ACCOUNT_ALIAS).await?;
 
     println!("Generating {NUM_ADDRESSES_TO_GENERATE} addresses...");
     let now = tokio::time::Instant::now();

sdk/examples/wallet/logger.rs

@@ -46,13 +46,7 @@ async fn main() -> Result<()> {
         .await?;
 
     // Get or create a new account
-    let alias = "Alice";
-    let account = if let Ok(account) = wallet.get_account(alias).await {
-        account
-    } else {
-        println!("Creating account '{alias}'");
-        wallet.create_account().with_alias(alias).finish().await?
-    };
+    let account = wallet.get_or_create_account("Alice").await?;
 
     println!("Generating {NUM_ADDRESSES_TO_GENERATE} addresses...");
     let _ = account

sdk/examples/wallet/spammer.rs

@@ -45,7 +45,7 @@ async fn main() -> Result<()> {
         .with_coin_type(SHIMMER_COIN_TYPE)
         .finish()
         .await?;
-    let account = get_or_create_account(&wallet, ACCOUNT_ALIAS).await?;
+    let account = wallet.get_or_create_account(ACCOUNT_ALIAS).await?;
 
     let recv_address = *account.addresses().await?[0].address();
     println!("Recv address: {}", recv_address);
@@ -141,15 +141,6 @@ async fn main() -> Result<()> {
     Ok(())
 }
 
-async fn get_or_create_account(wallet: &Wallet, alias: &str) -> Result<Account> {
-    Ok(if let Ok(account) = wallet.get_account(alias).await {
-        account
-    } else {
-        println!("Creating account '{alias}'");
-        wallet.create_account().with_alias(alias).finish().await?
-    })
-}
-
 async fn ensure_enough_funds(account: &Account, bech32_address: &Bech32Address) -> Result<()> {
     let balance = account.sync(None).await?;
     let available_funds = balance.base_coin().available();

sdk/examples/wallet/split_funds.rs

@@ -43,7 +43,7 @@ async fn main() -> Result<()> {
         .await?;
 
     // Get account or create a new one
-    let account = create_account(&wallet, "Alice").await?;
+    let account = wallet.get_or_create_account("Alice").await?;
 
     let _ = ensure_enough_addresses(&account, ADDRESSES_TO_SPLIT_FUNDS).await?;
 
@@ -109,15 +109,6 @@ async fn main() -> Result<()> {
     Ok(())
 }
 
-async fn create_account(wallet: &Wallet, alias: &str) -> Result<Account> {
-    Ok(if let Ok(account) = wallet.get_account(alias).await {
-        account
-    } else {
-        println!("Creating account '{alias}'");
-        wallet.create_account().with_alias(alias).finish().await?
-    })
-}
-
 async fn sync_print_balance(account: &Account) -> Result<()> {
     let alias = account.alias().await;
     let now = tokio::time::Instant::now();

sdk/examples/wallet/storage.rs

@@ -37,7 +37,7 @@ async fn main() -> Result<()> {
         .await?;
 
     // Get account or create a new one
-    let account = get_or_create_account(&wallet, "Alice").await?;
+    let account = wallet.get_or_create_account("Alice").await?;
 
     let addresses = generate_max_addresses(&account, MAX_ADDRESSES_TO_GENERATE).await?;
     let bech32_addresses = addresses
@@ -57,15 +57,6 @@ async fn main() -> Result<()> {
     Ok(())
 }
 
-async fn get_or_create_account(wallet: &Wallet, alias: &str) -> Result<Account> {
-    Ok(if let Ok(account) = wallet.get_account(alias).await {
-        account
-    } else {
-        println!("Creating account '{alias}'");
-        wallet.create_account().with_alias(alias).finish().await?
-    })
-}
-
 async fn generate_max_addresses(account: &Account, max: usize) -> Result<Vec<AccountAddress>> {
     let alias = account.alias().await;
     if account.addresses().await?.len() < max {

sdk/examples/wallet/wallet.rs

@@ -39,7 +39,7 @@ async fn main() -> Result<()> {
 
     let wallet = create_wallet().await?;
 
-    let account = get_or_create_account(&wallet, "Alice").await?;
+    let account = wallet.get_or_create_account("Alice").await?;
     print_accounts(&wallet).await?;
 
     generate_addresses(&account, MAX_ADDRESSES_TO_GENERATE).await?;
@@ -72,16 +72,6 @@ async fn create_wallet() -> Result<Wallet> {
         .await
 }
 
-async fn get_or_create_account(wallet: &Wallet, alias: &str) -> Result<Account> {
-    let account = if let Ok(account) = wallet.get_account(alias).await {
-        account
-    } else {
-        println!("Creating account '{alias}'");
-        wallet.create_account().with_alias(alias).finish().await?
-    };
-    Ok(account)
-}
-
 async fn print_accounts(wallet: &Wallet) -> Result<()> {
     let accounts = wallet.get_accounts().await?;
     println!("Accounts:");

sdk/src/types/block/output/feature/mod.rs

@@ -38,12 +38,12 @@ pub enum Feature {
 
 impl PartialOrd for Feature {
     fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
-        self.kind().partial_cmp(&other.kind())
+        Some(self.cmp(other))
     }
 }
 impl Ord for Feature {
     fn cmp(&self, other: &Self) -> core::cmp::Ordering {
-        self.partial_cmp(other).unwrap()
+        self.kind().cmp(&other.kind())
     }
 }
 

sdk/src/types/block/output/native_token.rs

@@ -53,12 +53,12 @@ impl NativeToken {
 
 impl PartialOrd for NativeToken {
     fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
-        self.token_id.partial_cmp(&other.token_id)
+        Some(self.cmp(other))
     }
 }
 impl Ord for NativeToken {
     fn cmp(&self, other: &Self) -> core::cmp::Ordering {
-        self.partial_cmp(other).unwrap()
+        self.token_id.cmp(&other.token_id)
     }
 }
 

sdk/src/types/block/output/unlock_condition/mod.rs

@@ -55,12 +55,12 @@ pub enum UnlockCondition {
 
 impl PartialOrd for UnlockCondition {
     fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
-        self.kind().partial_cmp(&other.kind())
+        Some(self.cmp(other))
     }
 }
 impl Ord for UnlockCondition {
     fn cmp(&self, other: &Self) -> core::cmp::Ordering {
-        self.partial_cmp(other).unwrap()
+        self.kind().cmp(&other.kind())
     }
 }
 

sdk/src/types/block/payload/milestone/option/mod.rs

@@ -46,12 +46,12 @@ impl MilestoneOption {
 
 impl PartialOrd for MilestoneOption {
     fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
-        self.kind().partial_cmp(&other.kind())
+        Some(self.cmp(other))
     }
 }
 impl Ord for MilestoneOption {
     fn cmp(&self, other: &Self) -> core::cmp::Ordering {
-        self.partial_cmp(other).unwrap()
+        self.kind().cmp(&other.kind())
     }
 }
 

sdk/src/wallet/core/operations/get_account.rs

@@ -44,3 +44,16 @@ impl<S: SecretManage> Wallet<S> {
         )?))
     }
 }
+
+impl<S: 'static + SecretManage> Wallet<S>
+where
+    crate::wallet::Error: From<S::Error>,
+{
+    pub async fn get_or_create_account(&self, alias: impl Into<String> + Send) -> crate::wallet::Result<Account<S>> {
+        let alias = alias.into();
+        match self.get_account(&alias).await {
+            Err(crate::wallet::Error::AccountNotFound(_)) => self.create_account().with_alias(alias).finish().await,
+            res => res,
+        }
+    }
+}