chore: mint task enhancement (#543)

* chore: ask for mnemonic right after provided account address

* chore: make the error visible in the beginning

* fix: check for NFT validation error

* fix: asset name and decimal validations

* fix: on callbacks running twice

docs/cli/index.md

@@ -160,14 +160,14 @@
     - [mint](#mint)
     - [Options](#options-25)
     - [--creator ](#--creator-)
-    - [-n, --name ](#-n---name--3)
+    - [--name ](#--name-)
     - [-u, --unit ](#-u---unit-)
     - [-t, --total ](#-t---total-)
     - [-d, --decimals ](#-d---decimals-)
+    - [--nft, --ft](#--nft---ft)
     - [-i, --image ](#-i---image-)
     - [-m, --metadata ](#-m---metadata-)
     - [--mutable, --immutable](#--mutable---immutable)
-    - [--nft, --ft](#--nft---ft)
     - [-n, --network ](#-n---network-)
     - [nfd-lookup](#nfd-lookup)
     - [Options](#options-26)
@@ -1111,8 +1111,8 @@ algokit task mint [OPTIONS]
 **Required** Address or alias of the asset creator.
 
 
-### -n, --name <asset_name>
-**Required** Asset name.
+### --name <asset_name>
+Asset name.
 
 
 ### -u, --unit <unit_name>
@@ -1127,6 +1127,11 @@ Total supply of the asset. Defaults to 1.
 Number of decimals. Defaults to 0.
 
 
+### --nft, --ft
+Whether the asset should be validated as NFT or FT. Refers to NFT by default and validates canonical
+definitions of pure or fractional NFTs as per ARC3 standard.
+
+
 ### -i, --image <image_path>
 **Required** Path to the asset image file to be uploaded to IPFS.
 
@@ -1141,11 +1146,6 @@ For more details refer to [https://arc.algorand.foundation/ARCs/arc-0003#json-me
 Whether the asset should be mutable or immutable. Refers to ARC19 by default.
 
 
-### --nft, --ft
-Whether the asset should be validated as NFT or FT. Refers to NFT by default and validates canonical
-definitions of pure or fractional NFTs as per ARC3 standard.
-
-
 ### -n, --network <network>
 Network to use. Refers to localnet by default.
 

src/algokit/cli/tasks/mint.py

@@ -1,8 +1,10 @@
+import json
 import logging
 import math
 from pathlib import Path
 
 import click
+from algokit_utils import Account
 from algosdk.error import AlgodHTTPError
 from algosdk.util import algos_to_microalgos
 
@@ -11,6 +13,7 @@
 from algokit.cli.tasks.utils import (
     get_account_with_private_key,
     load_algod_client,
+    run_callback_once,
     validate_balance,
 )
 from algokit.core.tasks.ipfs import (
@@ -72,18 +75,37 @@ def _validate_unit_name(context: click.Context, param: click.Parameter, value: s
         )
 
 
-def _validate_asset_name(context: click.Context, param: click.Parameter, value: str) -> str:
+def _get_and_validate_asset_name(context: click.Context, param: click.Parameter, value: str | None) -> str:
     """
     Validate the asset name by checking if its byte length is less than or equal to a predefined maximum value.
+    If asset name has not been supplied in the metadata file or via an argument a prompt is displayed.
 
     Args:
         context (click.Context): The click context.
         param (click.Parameter): The click parameter.
-        value (str): The value of the parameter.
+        value (str|None): The value of the parameter.
 
     Returns:
         str: The value of the parameter if it passes the validation.
     """
+    token_metadata_path = context.params.get("token_metadata_path")
+    token_name = None
+
+    if token_metadata_path is not None:
+        with Path(token_metadata_path).open("r") as metadata_file:
+            data = json.load(metadata_file)
+            token_name = data.get("name")
+
+    if value is None:
+        if token_name is None:
+            value = click.prompt("Provide the asset name", type=str)
+        else:
+            value = token_name
+    elif token_name is not None and token_name != value:
+        raise click.BadParameter("Token name in metadata JSON must match CLI argument providing token name!")
+
+    if value is None:
+        raise click.BadParameter("Asset name cannot be None")
 
     if len(value.encode("utf-8")) <= MAX_ASSET_NAME_BYTE_LENGTH:
         return value
@@ -93,6 +115,75 @@ def _validate_asset_name(context: click.Context, param: click.Parameter, value:
         )
 
 
+def _get_creator_account(_: click.Context, __: click.Parameter, value: str) -> Account:
+    """
+    Validate the creator account by checking if it is a valid Algorand address.
+
+    Args:
+        context (click.Context): The click context.
+        value (str): The value of the parameter.
+
+    Returns:
+        Account: An account object with the address and private key.
+    """
+    try:
+        return get_account_with_private_key(value)
+    except Exception as ex:
+        raise click.BadParameter(str(ex)) from ex
+
+
+def _get_and_validate_decimals(context: click.Context, _: click.Parameter, value: int | None) -> int:
+    """
+    Validate the number of decimal places for the token.
+    If decimals has not been supplied in the metadata file or via an argument a prompt is displayed.
+
+    Args:
+        context (click.Context): The click context.
+        value (int|None): The value of the parameter.
+
+    Returns:
+        int: The value of the parameter if it passes the validation.
+    """
+    token_metadata_path = context.params.get("token_metadata_path")
+    token_decimals = None
+    if token_metadata_path is not None:
+        with Path(token_metadata_path).open("r") as metadata_file:
+            data = json.load(metadata_file)
+            token_decimals = data.get("decimals")
+
+    if value is None:
+        if token_decimals is None:
+            decimals: int = click.prompt("Provide the asset decimals", type=int, default=0)
+            return decimals
+        return int(token_decimals)
+    else:
+        if token_decimals is not None and token_decimals != value:
+            raise click.BadParameter("The value for decimals in the metadata JSON must match the decimals argument.")
+        return value
+
+
+def _validate_supply_for_nft(context: click.Context, _: click.Parameter, value: bool) -> bool:  # noqa: FBT001
+    """
+    Validate the total supply and decimal places for NFTs.
+
+    Args:
+        context (click.Context): The click context.
+        value (bool): The value of the parameter.
+
+    Returns:
+        bool: The value of the parameter if it passes the validation.
+    """
+    if value:
+        try:
+            total = context.params.get("total")
+            decimals = context.params.get("decimals")
+            if total is not None and decimals is not None:
+                _validate_supply(total, decimals)
+        except click.ClickException as ex:
+            raise ex
+    return value
+
+
 @click.command(
     name="mint",
     help="Mint new fungible or non-fungible assets on Algorand.",
@@ -103,26 +194,28 @@ def _validate_asset_name(context: click.Context, param: click.Parameter, value:
     prompt="Provide the address or alias of the asset creator",
     help="Address or alias of the asset creator.",
     type=click.STRING,
+    callback=run_callback_once(_get_creator_account),
+    is_eager=True,
 )
 @click.option(
-    "-n",
     "--name",
     "asset_name",
     type=click.STRING,
-    required=True,
-    callback=_validate_asset_name,
-    prompt="Provide the asset name",
+    required=False,
+    callback=_get_and_validate_asset_name,
     help="Asset name.",
+    is_eager=True,
 )
 @click.option(
     "-u",
     "--unit",
     "unit_name",
     type=click.STRING,
     required=True,
-    callback=_validate_unit_name,
+    callback=run_callback_once(_validate_unit_name),
     prompt="Provide the unit name",
     help="Unit name of the asset.",
+    is_eager=True,
 )
 @click.option(
     "-t",
@@ -132,15 +225,26 @@ def _validate_asset_name(context: click.Context, param: click.Parameter, value:
     default=1,
     prompt="Provide the total supply",
     help="Total supply of the asset. Defaults to 1.",
+    is_eager=True,
 )
 @click.option(
     "-d",
     "--decimals",
     type=click.INT,
     required=False,
-    default=0,
-    prompt="Provide the number of decimals",
+    callback=_get_and_validate_decimals,
     help="Number of decimals. Defaults to 0.",
+    is_eager=True,  # This option needs to be evaluated before nft option.
+)
+@click.option(
+    "--nft/--ft",
+    "non_fungible",
+    type=click.BOOL,
+    prompt="Validate asset as NFT? Checks values of `total` and `decimals` as per ARC3 if set to True.",
+    default=False,
+    callback=_validate_supply_for_nft,
+    help="""Whether the asset should be validated as NFT or FT. Refers to NFT by default and validates canonical
+    definitions of pure or fractional NFTs as per ARC3 standard.""",
 )
 @click.option(
     "-i",
@@ -169,15 +273,6 @@ def _validate_asset_name(context: click.Context, param: click.Parameter, value:
     default=False,
     help="Whether the asset should be mutable or immutable. Refers to `ARC19` by default.",
 )
-@click.option(
-    "--nft/--ft",
-    "non_fungible",
-    type=click.BOOL,
-    prompt="Validate asset as NFT? Checks values of `total` and `decimals` as per ARC3 if set to True.",
-    default=False,
-    help="""Whether the asset should be validated as NFT or FT. Refers to NFT by default and validates canonical
-    definitions of pure or fractional NFTs as per ARC3 standard.""",
-)
 @click.option(
     "-n",
     "--network",
@@ -189,49 +284,40 @@ def _validate_asset_name(context: click.Context, param: click.Parameter, value:
 )
 def mint(  # noqa: PLR0913
     *,
-    creator: str,
+    creator: Account,
     asset_name: str,
     unit_name: str,
     total: int,
     decimals: int,
     image_path: Path,
     token_metadata_path: Path | None,
     mutable: bool,
-    non_fungible: bool,
     network: AlgorandNetwork,
+    non_fungible: bool,  # noqa: ARG001
 ) -> None:
-    if non_fungible:
-        _validate_supply(total, decimals)
-
-    creator_account = get_account_with_private_key(creator)
-
     pinata_jwt = get_pinata_jwt()
     if not pinata_jwt:
         raise click.ClickException("You are not logged in! Please login using `algokit task ipfs login`.")
 
     client = load_algod_client(network)
     validate_balance(
         client,
-        creator_account,
+        creator,
         0,
         algos_to_microalgos(ASSET_MINTING_MBR),  # type: ignore[no-untyped-call]
     )
 
-    token_metadata = TokenMetadata.from_json_file(token_metadata_path)
-    if not token_metadata_path:
-        token_metadata.name = asset_name
-        token_metadata.decimals = decimals
+    token_metadata = TokenMetadata.from_json_file(token_metadata_path, asset_name, decimals)
     try:
         asset_id, txn_id = mint_token(
             client=client,
             jwt=pinata_jwt,
-            creator_account=creator_account,
+            creator_account=creator,
+            unit_name=unit_name,
+            total=total,
             token_metadata=token_metadata,
             image_path=image_path,
-            unit_name=unit_name,
-            asset_name=asset_name,
             mutable=mutable,
-            total=total,
         )
 
         click.echo("\nSuccessfully minted the asset!")

src/algokit/cli/tasks/utils.py

@@ -4,6 +4,9 @@
 import os
 import stat
 import sys
+from collections.abc import Callable
+from functools import wraps
+from typing import Any
 
 import algosdk
 import algosdk.encoding
@@ -297,3 +300,27 @@ def get_account_info(algod_client: algosdk.v2client.algod.AlgodClient, account_a
     account_info = algod_client.account_info(account_address)
     assert isinstance(account_info, dict)
     return account_info
+
+
+def run_callback_once(callback: Callable) -> Callable:
+    """
+    Click option callbacks run twice, first to validate the prompt input,
+    and then independently from that is used to validate the value passed to the option.
+
+    In cases where the callback is expensive or has side effects(like prompting the user),
+    it's better to run it only once.
+    """
+
+    @wraps(callback)
+    def wrapper(context: click.Context, param: click.Parameter, value: Any) -> Any:  # noqa: ANN401
+        if context.obj is None:
+            context.obj = {}
+
+        key = f"{param.name}_callback_result"
+        if key not in context.obj:
+            result = callback(context, param, value)
+            context.obj[key] = result
+            return result
+        return context.obj[key]
+
+    return wrapper