htcli 1.1.0__py3-none-any.whl

src/htcli/commands/wallet/__init__.py

@@ -0,0 +1,546 @@
+"""
+Wallet command module.
+
+Provides wallet management functionality including generation, restoration, listing, and operations.
+Migrated from the original wallet commands with the new folder-based architecture.
+"""
+
+from typing import Optional
+from textwrap import dedent
+
+import typer
+
+from .handlers import (
+    balance_handler,
+    check_hotkey_owner_handler,
+    delete_handler,
+    describe_handler,
+    generate_coldkey_handler,
+    generate_handler,
+    generate_hotkey_handler,
+    list_wallets_handler,
+    restore_coldkey_handler,
+    restore_hotkey_handler,
+    status_handler,
+    transfer_handler,
+    update_coldkey_handler,
+    update_hotkey_handler,
+    rotate_coldkey_handler,
+    rotate_hotkey_handler,
+    upgrade_wallet_layout_handler,
+    update_identity_handler,
+)
+
+app = typer.Typer(name="wallet", help="Wallet operations and management")
+
+
+DELETE_HELP = dedent(
+    """\
+    Delete wallets with confirmation.
+
+    \b
+    Usage:
+      - To delete a coldkey: --coldkey <name>
+      - To delete a hotkey: --coldkey <owner_name> --hotkey <name>
+    """
+)
+
+ROTATE_COLDKEY_HELP = dedent(
+    """\
+    Rotate a coldkey to a new keypair.
+
+    This operation:
+
+    \b
+      1. Generates a new keypair in memory.
+      2. Submits an on-chain extrinsic to update the coldkey address.
+      3. Backs up the old wallet file.
+      4. Overwrites the local wallet file with the new keypair.
+
+    \b
+    Warning:
+      Ensure you have backed up your old key before running this.
+    """
+)
+
+ROTATE_HOTKEY_HELP = dedent(
+    """\
+    Rotate a hotkey to a new keypair.
+
+    This operation:
+
+    \b
+      1. Generates a new keypair in memory.
+      2. Submits an on-chain extrinsic signed by the owner to update the hotkey address.
+      3. Backs up the old wallet file.
+      4. Overwrites the local wallet file with the new keypair.
+
+    \b
+    Warning:
+      Ensure you have backed up your old key before running this.
+    """
+)
+
+
+@app.command()
+def generate(
+    coldkey_name: Optional[str] = typer.Option(
+        None, "--coldkey", "-c", help="Coldkey wallet name"
+    ),
+    hotkey_name: Optional[str] = typer.Option(
+        None, "--hotkey", "-h", help="Hotkey name"
+    ),
+    password: Optional[str] = typer.Option(
+        None, "--password", "-p", help="Key password"
+    ),
+    no_password: bool = typer.Option(
+        False, "--no-password", help="Skip password encryption (no prompt)"
+    ),
+    copy_mnemonic: bool = typer.Option(
+        False,
+        "--copy-mnemonic",
+        help="Copy recovery phrase to clipboard after generation",
+    ),
+):
+    """Generate a new wallet with both coldkey and hotkey at once."""
+    # If --no-password is set, use empty string to skip encryption
+    final_password = "" if no_password else password
+    generate_handler(
+        coldkey_name=coldkey_name,
+        hotkey_name=hotkey_name,
+        key_type="ecdsa",
+        password=final_password,
+        copy_mnemonic=copy_mnemonic,
+    )
+
+
+@app.command()
+def generate_hotkey(
+    hotkey_name: Optional[str] = typer.Option(
+        None, "--hotkey", "-h", help="Hotkey name"
+    ),
+    coldkey_name: Optional[str] = typer.Option(
+        None,
+        "--coldkey",
+        "-c",
+        "--owner",
+        help="Coldkey wallet name that owns this hotkey (alias: --owner)",
+    ),
+    password: Optional[str] = typer.Option(
+        None, "--password", "-p", help="Key password"
+    ),
+    no_password: bool = typer.Option(
+        False, "--no-password", help="Skip password encryption (no prompt)"
+    ),
+    copy_mnemonic: bool = typer.Option(
+        False,
+        "--copy-mnemonic",
+        help="Copy recovery phrase to clipboard after generation",
+    ),
+):
+    """Generate a new hotkey with comprehensive guidance."""
+    # If --no-password is set, use empty string to skip encryption
+    final_password = "" if no_password else password
+    generate_hotkey_handler(
+        name=hotkey_name,
+        coldkey_name=coldkey_name,
+        key_type="ecdsa",
+        password=final_password,
+        copy_mnemonic=copy_mnemonic,
+    )
+
+
+@app.command()
+def generate_coldkey(
+    name: Optional[str] = typer.Option(None, "--name", "-n", help="Coldkey name"),
+    password: Optional[str] = typer.Option(
+        None, "--password", "-p", help="Key password"
+    ),
+    no_password: bool = typer.Option(
+        False, "--no-password", help="Skip password encryption (no prompt)"
+    ),
+    copy_mnemonic: bool = typer.Option(
+        False,
+        "--copy-mnemonic",
+        help="Copy recovery phrase to clipboard after generation",
+    ),
+):
+    """Generate a new coldkey with comprehensive guidance."""
+    # If --no-password is set, use empty string to skip encryption
+    final_password = "" if no_password else password
+    generate_coldkey_handler(
+        name=name,
+        key_type="ecdsa",  # Fixed to ECDSA for HyperTensor EVM compatibility
+        password=final_password,
+        copy_mnemonic=copy_mnemonic,
+    )
+
+
+@app.command()
+def restore_coldkey(
+    name: Optional[str] = typer.Option(None, "--name", "-n", help="Coldkey name"),
+    private_key: Optional[str] = typer.Option(
+        None, "--private-key", "-p", help="Private key to restore from"
+    ),
+    mnemonic: Optional[str] = typer.Option(
+        None, "--mnemonic", "-m", help="Mnemonic phrase to restore from"
+    ),
+    key_type: str = typer.Option(
+        "ecdsa", "--type", "-t", help="Key type (ecdsa/sr25519/ed25519)"
+    ),
+    password: Optional[str] = typer.Option(None, "--password", help="Key password"),
+):
+    """Restore a coldkey from private key or mnemonic."""
+    restore_coldkey_handler(
+        name=name,
+        private_key=private_key,
+        mnemonic=mnemonic,
+        key_type=key_type,
+        password=password,
+    )
+
+
+@app.command()
+def restore_hotkey(
+    hotkey_name: Optional[str] = typer.Option(
+        None, "--hotkey", "-h", help="Hotkey name"
+    ),
+    private_key: Optional[str] = typer.Option(
+        None, "--private-key", "-p", help="Private key to restore from"
+    ),
+    mnemonic: Optional[str] = typer.Option(
+        None, "--mnemonic", "-m", help="Mnemonic phrase to restore from"
+    ),
+    coldkey_name: Optional[str] = typer.Option(
+        None,
+        "--coldkey",
+        "-c",
+        "--owner",
+        help="Coldkey wallet name that owns this hotkey (alias: --owner)",
+    ),
+    key_type: str = typer.Option(
+        "ecdsa", "--type", "-t", help="Key type (ecdsa/sr25519/ed25519)"
+    ),
+    password: Optional[str] = typer.Option(None, "--password", help="Key password"),
+):
+    """Restore a hotkey from private key or mnemonic."""
+    restore_hotkey_handler(
+        name=hotkey_name,
+        private_key=private_key,
+        mnemonic=mnemonic,
+        owner_name=coldkey_name,
+        key_type=key_type,
+        password=password,
+    )
+
+
+@app.command()
+def list(
+    format_type: str = typer.Option(
+        "tree", "--format", "-f", help="Output format (tree/table/json)"
+    ),
+    show_balances: bool = typer.Option(
+        False, "--balances", "-b", help="Show wallet balances"
+    ),
+):
+    """List all wallets with comprehensive information."""
+    list_wallets_handler(format_type=format_type, show_balances=show_balances)
+
+
+# @app.command()
+# def status(
+#     format_type: str = typer.Option(
+#         "table", "--format", "-f", help="Output format (table/json)"
+#     ),
+#     check_balances: bool = typer.Option(
+#         False, "--balances", "-b", help="Check wallet balances"
+#     ),
+# ):
+#     """Show wallet status and identity information."""
+#     status_handler(format_type=format_type, check_balances=check_balances)
+
+
+@app.command(help=DELETE_HELP)
+def delete(
+    coldkey: Optional[str] = typer.Option(
+        None,
+        "--coldkey",
+        "-c",
+        help="Coldkey name to delete (required for coldkey deletion)",
+    ),
+    hotkey: Optional[str] = typer.Option(
+        None,
+        "--hotkey",
+        "-h",
+        help="Hotkey name to delete (requires --coldkey to specify owner)",
+    ),
+    force: bool = typer.Option(
+        False, "--force", "-f", help="Skip confirmation prompts"
+    ),
+):
+    """Delete wallets with confirmation."""
+    delete_handler(coldkey=coldkey, hotkey=hotkey, force=force)
+
+
+@app.command()
+def balance(
+    wallet_name: Optional[str] = typer.Option(
+        None,
+        "--coldkey",
+        "-c",
+        "--name",
+        "-n",
+        help="Coldkey wallet name to check balance",
+    ),
+    address: Optional[str] = typer.Option(
+        None, "--address", "-a", help="Address to check balance"
+    ),
+    show_all: bool = typer.Option(False, "--all", help="Show balance for all wallets"),
+    format_type: str = typer.Option(
+        "table", "--format", "-f", help="Output format (table/json)"
+    ),
+    show_guidance: bool = typer.Option(
+        True, "--guidance/--no-guidance", help="Show comprehensive guidance"
+    ),
+):
+    """Check balance of a wallet, address, or all wallets."""
+    balance_handler(
+        wallet_name=wallet_name,
+        address=address,
+        show_all=show_all,
+        format_type=format_type,
+        show_guidance=show_guidance,
+    )
+
+
+@app.command()
+def transfer(
+    from_wallet: Optional[str] = typer.Option(
+        None, "--from", "-f", help="Source wallet name"
+    ),
+    to_address: Optional[str] = typer.Option(
+        None, "--to", "-t", help="Destination address"
+    ),
+    amount: Optional[float] = typer.Option(
+        None, "--amount", "-a", help="Amount to transfer"
+    ),
+    password: Optional[str] = typer.Option(
+        None, "--password", "-p", help="Wallet password"
+    ),
+    dry_run: bool = typer.Option(
+        False, "--dry-run", help="Show transfer details without executing"
+    ),
+):
+    """Transfer balance from one wallet to another address."""
+    transfer_handler(
+        from_wallet=from_wallet,
+        to_address=to_address,
+        amount=amount,
+        password=password,
+        dry_run=dry_run,
+    )
+
+
+@app.command("update-coldkey")
+def update_coldkey_cmd(
+    name: Optional[str] = typer.Option(None, "--name", "-n", help="Coldkey name"),
+    new_name: Optional[str] = typer.Option(None, "--new-name", help="New wallet name"),
+    new_password: Optional[str] = typer.Option(
+        None, "--new-password", help="New password"
+    ),
+    current_password: Optional[str] = typer.Option(
+        None, "--current-password", help="Current password"
+    ),
+):
+    """Update coldkey password or other properties."""
+    update_coldkey_handler(
+        name=name,
+        new_name=new_name,
+        new_password=new_password,
+        current_password=current_password,
+    )
+
+
+@app.command("update-hotkey")
+def update_hotkey_cmd(
+    hotkey_name: Optional[str] = typer.Option(
+        None, "--hotkey", "-h", help="Hotkey name"
+    ),
+    coldkey_name: Optional[str] = typer.Option(
+        None,
+        "--coldkey",
+        "-c",
+        "--owner",
+        help="Current coldkey name (required to identify the hotkey, alias: --owner)",
+    ),
+    new_password: Optional[str] = typer.Option(
+        None, "--new-password", help="New password"
+    ),
+    current_password: Optional[str] = typer.Option(
+        None, "--current-password", help="Current password"
+    ),
+    new_coldkey: Optional[str] = typer.Option(
+        None, "--new-coldkey", help="New coldkey name"
+    ),
+    new_hotkey: Optional[str] = typer.Option(
+        None, "--new-hotkey", help="New hotkey name"
+    ),
+):
+    """Update hotkey password, coldkey, or other properties."""
+    update_hotkey_handler(
+        name=hotkey_name,
+        owner_name=coldkey_name,
+        new_password=new_password,
+        current_password=current_password,
+        new_owner=new_coldkey,
+        new_name=new_hotkey,
+    )
+
+
+@app.command("rotate-coldkey", help=ROTATE_COLDKEY_HELP)
+def rotate_coldkey(
+    name: Optional[str] = typer.Option(None, "--name", "-n", help="Coldkey name"),
+    password: Optional[str] = typer.Option(
+        None, "--password", "-p", help="Key password"
+    ),
+):
+    """Rotate a coldkey to a new keypair."""
+    if not name:
+        from .prompts import prompt_wallet_selection
+
+        name = prompt_wallet_selection("Select coldkey to rotate", is_hotkey=False)
+
+    rotate_coldkey_handler(name=name, password=password)
+
+
+@app.command("rotate-hotkey", help=ROTATE_HOTKEY_HELP)
+def rotate_hotkey(
+    name: Optional[str] = typer.Option(None, "--name", "-n", help="Hotkey name"),
+    owner_name: Optional[str] = typer.Option(
+        None, "--owner", "-o", help="Owner coldkey name (required)"
+    ),
+    password: Optional[str] = typer.Option(
+        None, "--password", "-p", help="Key password"
+    ),
+):
+    """Rotate a hotkey to a new keypair."""
+    if not name:
+        from .prompts import prompt_wallet_selection
+
+        name = prompt_wallet_selection("Select hotkey to rotate", is_hotkey=True)
+
+    rotate_hotkey_handler(name=name, owner_name=owner_name, password=password)
+
+
+@app.command()
+def describe(
+    name: Optional[str] = typer.Option(
+        None, "--name", "-n", help="Wallet name to describe"
+    ),
+):
+    """Describe a wallet with detailed information including balance and full address."""
+    describe_handler(name=name)
+
+
+@app.command("check-hotkey-owner")
+def check_hotkey_owner(
+    hotkey: Optional[str] = typer.Option(None, "--hotkey", "-h", help="Hotkey name"),
+    address: Optional[str] = typer.Option(
+        None, "--address", "-a", help="Hotkey address"
+    ),
+    coldkey: Optional[str] = typer.Option(
+        None,
+        "--coldkey",
+        "-c",
+        help="Coldkey name (required if hotkey name is ambiguous)",
+    ),
+):
+    """Check the on-chain owner of a hotkey."""
+    check_hotkey_owner_handler(
+        hotkey_name=hotkey,
+        hotkey_address=address,
+        coldkey_name=coldkey,
+    )
+
+
+@app.command()
+def upgrade(
+    dry_run: bool = typer.Option(
+        False, "--dry-run", help="Show actions without modifying files"
+    ),
+    force: bool = typer.Option(
+        False, "--force", "-f", help="Overwrite existing hierarchical files"
+    ),
+    no_backup: bool = typer.Option(
+        False, "--no-backup", help="Skip creating .bak backups before moving files"
+    ),
+    wallets: Optional[str] = typer.Option(
+        None,
+        "--wallets",
+        help="Comma-separated coldkey names to migrate (default: all legacy wallets)",
+    ),
+):
+    """Upgrade wallet storage layout to the per-coldkey hierarchy."""
+    wallet_list = (
+        [item.strip() for item in wallets.split(",") if item.strip()]
+        if wallets
+        else None
+    )
+    upgrade_wallet_layout_handler(
+        dry_run=dry_run,
+        force=force,
+        backup=not no_backup,
+        wallet_names=wallet_list,
+    )
+
+
+@app.command()
+def identity(
+    hotkey: Optional[str] = typer.Option(
+        None, "--hotkey", "-h", help="Hotkey name to update identity for"
+    ),
+    name: Optional[str] = typer.Option(None, "--name", "-n", help="Display name"),
+    url: Optional[str] = typer.Option(None, "--url", "-u", help="Website URL"),
+    image: Optional[str] = typer.Option(
+        None, "--image", "-i", help="Profile image URL"
+    ),
+    discord: Optional[str] = typer.Option(
+        None, "--discord", "-d", help="Discord handle"
+    ),
+    x: Optional[str] = typer.Option(None, "--x", "-x", help="X (Twitter) handle"),
+    telegram: Optional[str] = typer.Option(
+        None, "--telegram", "-t", help="Telegram handle"
+    ),
+    github: Optional[str] = typer.Option(
+        None, "--github", "-g", help="GitHub profile URL"
+    ),
+    hugging_face: Optional[str] = typer.Option(
+        None, "--hugging-face", "-hf", help="Hugging Face profile URL"
+    ),
+    description: Optional[str] = typer.Option(
+        None, "--description", "-desc", help="Short description"
+    ),
+    misc: Optional[str] = typer.Option(None, "--misc", "-m", help="Additional data"),
+    password: Optional[str] = typer.Option(
+        None, "--password", "-p", help="Wallet password"
+    ),
+):
+    """Register or update identity information for a hotkey."""
+    update_identity_handler(
+        hotkey_name=hotkey,
+        name=name,
+        url=url,
+        image=image,
+        discord=discord,
+        x=x,
+        telegram=telegram,
+        github=github,
+        hugging_face=hugging_face,
+        description=description,
+        misc=misc,
+        password=password,
+    )
+
+
+# Export the app for main.py
+__all__ = ["app"]