feat: Use AccountComponentTemplate (#680)

* feat: Use AccountComponentTemplate

* chore: Cargo lock

* reviews: Docs above attribues, roll back env var name

* reviews: fix rename

CHANGELOG.md

@@ -18,10 +18,11 @@
 * Created functions for creating standard notes and note scripts easily on the web client (#686).
 * [BREAKING] Renamed plural modules to singular (#687).
 * [BREAKING] Made `idxdb` only usable on WASM targets (#685).
-* Added fixed seed option for web client generation (#688)
+* Added fixed seed option for web client generation (#688).
 * [BREAKING] Updated `init` command in the CLI to receive a `--network` flag (#690).
 * Improved CLI error messages (#682).
 * [BREAKING] Renamed APIs for retrieving account information to use the `try_get_*` naming convention, and added/improved module documentation (#683).
+* Added account creation from component templates (#680).
 
 ### Fixes
 

bin/miden-cli/src/commands/account.rs

@@ -187,12 +187,8 @@ pub async fn show_account<R: FeltRng>(
 
         println!("Storage: \n");
 
-        let mut table = create_dynamic_table(&[
-            "Item Slot Index",
-            "Item Slot Type",
-            "Value Arity",
-            "Value/Commitment",
-        ]);
+        let mut table =
+            create_dynamic_table(&["Item Slot Index", "Item Slot Type", "Value/Commitment"]);
 
         for (idx, entry) in account_storage.slots().iter().enumerate() {
             let item = account_storage

bin/miden-cli/src/commands/init.rs

@@ -102,19 +102,19 @@ impl InitCmd {
         };
 
         let config_as_toml_string = toml::to_string_pretty(&cli_config).map_err(|err| {
-            CliError::Config("Failed to serialize config".to_string().into(), err.to_string())
+            CliError::Config("failed to serialize config".to_string().into(), err.to_string())
         })?;
 
         let mut file_handle = File::options()
             .write(true)
             .create_new(true)
             .open(&config_file_path)
             .map_err(|err| {
-                CliError::Config("Failed to create config file".to_string().into(), err.to_string())
+                CliError::Config("failed to create config file".to_string().into(), err.to_string())
             })?;
 
         file_handle.write(config_as_toml_string.as_bytes()).map_err(|err| {
-            CliError::Config("Failed to write config file".to_string().into(), err.to_string())
+            CliError::Config("failed to write config file".to_string().into(), err.to_string())
         })?;
 
         println!("Config file successfully created at: {:?}", config_file_path);

bin/miden-cli/src/commands/new_account.rs

@@ -1,14 +1,21 @@
+use std::{collections::BTreeMap, fs, io::Write, path::PathBuf};
+
 use clap::{Parser, ValueEnum};
 use miden_client::{
     account::{
-        AccountBuilder, AccountStorageMode, AccountType, BasicFungibleFaucetComponent,
-        BasicWalletComponent, RpoFalcon512Component,
+        component::{
+            AccountComponent, AccountComponentTemplate, BasicFungibleFaucet, BasicWallet,
+            InitStorageData, MapRepresentation, PlaceholderType, RpoFalcon512, StorageValue,
+        },
+        AccountBuilder, AccountStorageMode, AccountType,
     },
     asset::TokenSymbol,
     auth::AuthSecretKey,
     crypto::{FeltRng, SecretKey},
-    Client, Felt,
+    utils::Deserializable,
+    Client, Felt, Word,
 };
+use miden_lib::utils::parse_hex_string_as_word;
 
 use crate::{
     commands::account::maybe_set_default_account, errors::CliError, utils::load_config_file,
@@ -30,23 +37,102 @@ impl From<CliAccountStorageMode> for AccountStorageMode {
     }
 }
 
-#[derive(Debug, Parser, Clone)]
+/// Helper function to process extra component templates.
+/// It reads user input for each placeholder in a component template.
+// TODO: this could take a TOML file with key-values
+fn process_component_templates(
+    extra_components: &[AccountComponentTemplate],
+) -> Result<Vec<AccountComponent>, CliError> {
+    let mut account_components = vec![];
+    for component_template in extra_components {
+        let mut init_storage_data = BTreeMap::new();
+        for (placeholder_key, placeholder_type) in
+            component_template.metadata().get_unique_storage_placeholders()
+        {
+            print!(
+                "Enter hex value for placeholder '{}' (type: {}): ",
+                placeholder_key, placeholder_type
+            );
+            std::io::stdout().flush()?;
+
+            let mut input_value = String::new();
+            std::io::stdin().read_line(&mut input_value)?;
+            let input_value = input_value.trim();
+
+            match placeholder_type {
+                PlaceholderType::Felt => {
+                    let value = input_value
+                        .strip_prefix("0x")
+                        .ok_or("error parsing input: Missing 0x prefix".to_string())
+                        .map(|hex| {
+                            u64::from_str_radix(hex, 16).map_err(|e| {
+                                CliError::Parse(e.into(), "failed to parse hex from input".into())
+                            })
+                        })
+                        .map_err(|e| {
+                            CliError::Parse(e.into(), "failed to parse hex from input".into())
+                        })??;
+
+                    init_storage_data
+                        .insert(placeholder_key.clone(), StorageValue::Felt(Felt::new(value)));
+                },
+                PlaceholderType::Map => {
+                    // TODO: Test this case further
+                    let map: MapRepresentation = toml::from_str(input_value).map_err(|e| {
+                        CliError::Parse(e.into(), "failed to parse map from input".into())
+                    })?;
+                    let map = map.try_build_map(&Default::default()).map_err(|e| {
+                        CliError::Parse(e.into(), "failed to parse map from input".into())
+                    })?;
+
+                    init_storage_data.insert(placeholder_key.clone(), StorageValue::Map(map));
+                },
+                PlaceholderType::Word => {
+                    let word: Word = parse_hex_string_as_word(input_value).map_err(|e| {
+                        CliError::Parse(e.into(), "failed to parse hex from input".into())
+                    })?;
+
+                    init_storage_data.insert(placeholder_key.clone(), StorageValue::Word(word));
+                },
+            }
+        }
+        let component = AccountComponent::from_template(
+            component_template,
+            &InitStorageData::new(init_storage_data),
+        )
+        .map_err(|e| CliError::Account(e, "error instantiating component from template".into()))?
+        .with_supports_all_types();
+
+        account_components.push(component);
+    }
+
+    Ok(account_components)
+}
+
+// NEW FAUCET
+// ================================================================================================
+
 /// Create a new faucet account.
+#[derive(Debug, Parser, Clone)]
 pub struct NewFaucetCmd {
-    #[clap(value_enum, short, long, default_value_t = CliAccountStorageMode::Private)]
     /// Storage mode of the account.
+    #[clap(value_enum, short, long, default_value_t = CliAccountStorageMode::Private)]
     storage_mode: CliAccountStorageMode,
-    #[clap(short, long)]
     /// Defines if the account assets are non-fungible (by default it is fungible).
-    non_fungible: bool,
     #[clap(short, long)]
+    non_fungible: bool,
     /// Token symbol of the faucet.
-    token_symbol: Option<String>,
     #[clap(short, long)]
+    token_symbol: Option<String>,
     /// Decimals of the faucet.
+    #[clap(short, long)]
     decimals: Option<u8>,
+    /// Maximum amount of assets that the fungible faucet can distribute.
     #[clap(short, long)]
     max_supply: Option<u64>,
+    /// Optional list of files specifying addional components to add to the account.
+    #[clap(short, long)]
+    extra_components: Vec<PathBuf>,
 }
 
 impl NewFaucetCmd {
@@ -62,6 +148,18 @@ impl NewFaucetCmd {
             ));
         }
 
+        let mut extra_components = Vec::new();
+        for path in &self.extra_components {
+            let bytes = fs::read(path)?;
+            let template = AccountComponentTemplate::read_from_bytes(&bytes).map_err(|e| {
+                CliError::AccountComponentError(
+                    Box::new(e),
+                    "failed to read account component template".into(),
+                )
+            })?;
+            extra_components.push(template);
+        }
+
         let decimals = self.decimals.expect("decimals must be provided");
         let token_symbol = self.token_symbol.clone().expect("token symbol must be provided");
 
@@ -78,18 +176,23 @@ impl NewFaucetCmd {
 
         let anchor_block = client.get_latest_epoch_block().await?;
 
-        let (new_account, seed) = AccountBuilder::new(init_seed)
+        let mut builder = AccountBuilder::new(init_seed)
             .anchor((&anchor_block).try_into().expect("anchor block should be valid"))
             .account_type(AccountType::FungibleFaucet)
             .storage_mode(self.storage_mode.into())
-            .with_component(RpoFalcon512Component::new(key_pair.public_key()))
-            .with_component(
-                BasicFungibleFaucetComponent::new(symbol, decimals, max_supply).map_err(|err| {
-                    CliError::Account(err, "Failed to create a faucet".to_string())
-                })?,
-            )
+            .with_component(RpoFalcon512::new(key_pair.public_key()))
+            .with_component(BasicFungibleFaucet::new(symbol, decimals, max_supply).map_err(
+                |err| CliError::Account(err, "failed to create a faucet component".to_string()),
+            )?);
+
+        //add any extra component templates
+        for component in process_component_templates(&extra_components)? {
+            builder = builder.with_component(component);
+        }
+
+        let (new_account, seed) = builder
             .build()
-            .map_err(|err| CliError::Account(err, "Failed to create a faucet".to_string()))?;
+            .map_err(|err| CliError::Account(err, "error building account".into()))?;
 
         client
             .add_account(&new_account, Some(seed), &AuthSecretKey::RpoFalcon512(key_pair), false)
@@ -105,19 +208,37 @@ impl NewFaucetCmd {
     }
 }
 
-#[derive(Debug, Parser, Clone)]
+// NEW WALLET
+// ================================================================================================
+
 /// Create a new wallet account.
+#[derive(Debug, Parser, Clone)]
 pub struct NewWalletCmd {
-    #[clap(value_enum, short, long, default_value_t = CliAccountStorageMode::Private)]
     /// Storage mode of the account.
+    #[clap(value_enum, short, long, default_value_t = CliAccountStorageMode::Private)]
     pub storage_mode: CliAccountStorageMode,
-    #[clap(short, long)]
     /// Defines if the account code is mutable (by default it isn't mutable).
+    #[clap(short, long)]
     pub mutable: bool,
+    /// Optional list of files specifying addional components to add to the account.
+    #[clap(short, long)]
+    pub extra_components: Vec<PathBuf>,
 }
 
 impl NewWalletCmd {
     pub async fn execute(&self, mut client: Client<impl FeltRng>) -> Result<(), CliError> {
+        let mut extra_components = Vec::new();
+        for path in &self.extra_components {
+            let bytes = fs::read(path)?;
+            let template = AccountComponentTemplate::read_from_bytes(&bytes).map_err(|e| {
+                CliError::AccountComponentError(
+                    Box::new(e),
+                    "failed to read account component template".into(),
+                )
+            })?;
+            extra_components.push(template);
+        }
+
         let key_pair = SecretKey::with_rng(client.rng());
 
         let mut init_seed = [0u8; 32];
@@ -131,14 +252,21 @@ impl NewWalletCmd {
 
         let anchor_block = client.get_latest_epoch_block().await?;
 
-        let (new_account, seed) = AccountBuilder::new(init_seed)
+        let mut builder = AccountBuilder::new(init_seed)
             .anchor((&anchor_block).try_into().expect("anchor block should be valid"))
             .account_type(account_type)
             .storage_mode(self.storage_mode.into())
-            .with_component(RpoFalcon512Component::new(key_pair.public_key()))
-            .with_component(BasicWalletComponent)
+            .with_component(RpoFalcon512::new(key_pair.public_key()))
+            .with_component(BasicWallet);
+
+        //add any extra component templates
+        for component in process_component_templates(&extra_components)? {
+            builder = builder.with_component(component);
+        }
+
+        let (new_account, seed) = builder
             .build()
-            .map_err(|err| CliError::Account(err, "Failed to create a wallet".to_string()))?;
+            .map_err(|err| CliError::Account(err, "failed to create a wallet".to_string()))?;
 
         client
             .add_account(&new_account, Some(seed), &AuthSecretKey::RpoFalcon512(key_pair), false)

bin/miden-cli/src/errors.rs

@@ -5,11 +5,16 @@ use miden_objects::{AccountError, AccountIdError, AssetError};
 use miette::Diagnostic;
 use thiserror::Error;
 
+type SourceError = Box<dyn StdError + Send + Sync>;
+
 #[derive(Debug, Diagnostic, Error)]
 pub enum CliError {
     #[error("account error: {1}")]
     #[diagnostic(code(cli::account_error))]
     Account(#[source] AccountError, String),
+    #[error("account component error: {1}")]
+    #[diagnostic(code(cli::account_error))]
+    AccountComponentError(#[source] SourceError, String),
     #[error("account id error: {1}")]
     #[diagnostic(code(cli::accountid_error), help("Check the account ID format."))]
     AccountId(#[source] AccountIdError, String),
@@ -24,7 +29,7 @@ pub enum CliError {
         code(cli::config_error),
         help("Check if the configuration file exists and is well-formed.")
     )]
-    Config(#[source] Box<dyn StdError + Send + Sync>, String),
+    Config(#[source] SourceError, String),
     #[error("export error: {0}")]
     #[diagnostic(code(cli::export_error), help("Check the ID."))]
     Export(String),
@@ -45,10 +50,10 @@ pub enum CliError {
     MissingFlag(String),
     #[error("parse error: {1}")]
     #[diagnostic(code(cli::parse_error), help("Check the inputs."))]
-    Parse(#[source] Box<dyn StdError + Send + Sync>, String),
+    Parse(#[source] SourceError, String),
     #[error("transaction error: {1}")]
     #[diagnostic(code(cli::transaction_error))]
-    Transaction(#[source] Box<dyn StdError + Send + Sync>, String),
+    Transaction(#[source] SourceError, String),
 }
 
 impl From<CliError> for String {

bin/miden-cli/src/lib.rs

@@ -93,7 +93,6 @@ impl Cli {
 
         // Define whether we want to use the executor's debug mode based on the env var and
         // the flag override
-
         let in_debug_mode = match env::var("MIDEN_DEBUG") {
             Ok(value) if value.to_lowercase() == "true" => true,
             _ => self.debug,