htcli 1.1.0__py3-none-any.whl

src/htcli/commands/stake/error_handling.py

@@ -0,0 +1,425 @@
+"""
+Error handling utilities for stake commands.
+Provides user-friendly error messages for all stake-related errors.
+"""
+
+from typing import Optional
+
+from ...ui.components import HTCLIPanel
+from ...ui.display import HTCLIConsole
+
+
+def handle_stake_error(
+    error_msg: str,
+    subnet_id: Optional[int] = None,
+    subnet_node_id: Optional[int] = None,
+    operation: str = "operation",
+    client=None,
+) -> bool:
+    """
+    Handle stake-related errors with user-friendly messages.
+
+    Args:
+        error_msg: The error message from the blockchain
+        subnet_id: The subnet ID (if applicable)
+        subnet_node_id: The subnet node ID (if applicable)
+        operation: Description of the operation being performed
+        client: Optional client instance for fetching additional info
+
+    Returns:
+        bool: True if error was handled, False otherwise
+    """
+    console = HTCLIConsole()
+    subnet_id_str = f" {subnet_id}" if subnet_id is not None else ""
+    node_id_str = f" {subnet_node_id}" if subnet_node_id is not None else ""
+
+    # System-level errors (checked first)
+    if "Paused" in error_msg and "Subnet" not in error_msg:
+        error_panel = HTCLIPanel(
+            "The network is currently paused.\n\n"
+            "⏸️  All transactions are temporarily disabled on the network.\n\n"
+            "💡 Please wait for the network to resume operations.\n"
+            "   Check network status or try again later.",
+            title="⏸️  Network Paused",
+            border_style="htcli.warning",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "BadOrigin" in error_msg or (
+        "invalid" in error_msg.lower() and "signature" in error_msg.lower()
+    ):
+        error_panel = HTCLIPanel(
+            "Invalid transaction signature.\n\n"
+            "💡 This usually means:\n"
+            "   - Your wallet is not properly unlocked\n"
+            "   - The signing key doesn't match the account\n"
+            "   - There's an issue with your wallet configuration\n\n"
+            "   Try: htcli wallet unlock to unlock your wallet\n"
+            "   Or check your wallet configuration: htcli wallet list",
+            title="❌ Invalid Signature",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "TxRateLimitExceeded" in error_msg:
+        error_panel = HTCLIPanel(
+            "Transaction rate limit exceeded.\n\n"
+            "⏱️  You've exceeded the maximum number of transactions allowed for your account.\n\n"
+            "💡 Wait a moment before submitting another transaction.\n"
+            "   Rate limits help prevent spam and ensure network stability.",
+            title="⏳ Rate Limit Exceeded",
+            border_style="htcli.warning",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Minimum delegate stake deposit errors
+    elif "MinDelegateStakeDepositNotReached" in error_msg:
+        error_panel = HTCLIPanel(
+            f"The operation failed because the minimum delegate stake deposit requirement was not met.\n\n"
+            f"💡 What this means:\n"
+            f"   • Adding delegate stake requires a minimum deposit amount\n"
+            f"   • Transferring delegate stake must leave at least the minimum amount\n"
+            f"   • The minimum prevents dust amounts that could spam the network\n\n"
+            f"💡 How to fix:\n"
+            f"   • Check the minimum delegate stake requirement: htcli subnet info --subnet-id{subnet_id_str}\n"
+            f"   • Increase your stake amount to meet the minimum\n"
+            f"   • For transfers: ensure both sender and recipient meet minimums",
+            title="❌ Minimum Delegate Stake Not Reached",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Common errors
+    elif "InvalidSubnetId" in error_msg:
+        error_panel = HTCLIPanel(
+            f"Subnet{subnet_id_str} does not exist.\n\n"
+            f"💡 Check the subnet ID and try again.\n"
+            f"   Use: htcli subnet list to see available subnets",
+            title="❌ Invalid Subnet ID",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "InvalidSubnetNodeId" in error_msg:
+        error_panel = HTCLIPanel(
+            f"Subnet node{node_id_str} does not exist in subnet{subnet_id_str}.\n\n"
+            f"💡 Check the subnet node ID and try again.\n"
+            f"   Use: htcli node list --subnet-id{subnet_id_str} to see available nodes",
+            title="❌ Invalid Subnet Node ID",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "NotKeyOwner" in error_msg:
+        error_panel = HTCLIPanel(
+            "You are not the owner of this hotkey.\n\n"
+            "💡 Make sure you're using the correct coldkey wallet.\n"
+            "   Only the hotkey owner (coldkey) can perform this operation.\n"
+            "   Check your wallet: htcli wallet list",
+            title="❌ Permission Denied",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Amount validation errors
+    elif "InvalidAmount" in error_msg or "AmountZero" in error_msg:
+        error_panel = HTCLIPanel(
+            "Invalid stake amount.\n\n"
+            "💡 Stake amount must be greater than zero.\n"
+            "   Provide a valid stake amount and try again.",
+            title="❌ Invalid Amount",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "SharesZero" in error_msg:
+        error_panel = HTCLIPanel(
+            "Invalid shares amount.\n\n"
+            "💡 Shares amount must be greater than zero.\n"
+            "   Provide a valid shares amount and try again.",
+            title="❌ Invalid Shares",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Conversion errors
+    elif "CouldNotConvertToBalance" in error_msg:
+        error_panel = HTCLIPanel(
+            "Balance conversion failed.\n\n"
+            "💡 Failed to convert u128 value to BalanceOf type.\n"
+            "   This usually indicates an overflow or invalid value.\n"
+            "   Check your input values and try again.",
+            title="❌ Conversion Error",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "CouldNotConvertToShares" in error_msg:
+        error_panel = HTCLIPanel(
+            "Shares conversion failed.\n\n"
+            "💡 Failed to convert stake amount to shares.\n"
+            "   This usually happens when the amount is too small after rounding.\n"
+            "   Try increasing your stake amount slightly.",
+            title="❌ Shares Conversion Error",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Balance errors
+    elif "NotEnoughBalanceToStake" in error_msg:
+        error_panel = HTCLIPanel(
+            "Insufficient balance to stake.\n\n"
+            "💡 You don't have enough balance to stake and keep your account alive.\n"
+            "   Ensure your wallet has sufficient funds.\n"
+            "   Check your balance: htcli wallet balance",
+            title="❌ Insufficient Balance",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "NotEnoughBalance" in error_msg:
+        error_panel = HTCLIPanel(
+            "Insufficient balance.\n\n"
+            "💡 You don't have enough balance to complete this transaction.\n"
+            "   Ensure your wallet has sufficient funds.\n"
+            "   Check your balance: htcli wallet balance",
+            title="❌ Insufficient Balance",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "NotEnoughStakeToWithdraw" in error_msg:
+        error_panel = HTCLIPanel(
+            "Insufficient stake to withdraw.\n\n"
+            "💡 You don't have enough staked balance to withdraw this amount.\n"
+            "   Check your current stake: htcli stake list\n"
+            "   Reduce the withdrawal amount and try again.",
+            title="❌ Insufficient Stake",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "BalanceWithdrawalError" in error_msg:
+        error_panel = HTCLIPanel(
+            "Cannot withdraw balance - would kill account.\n\n"
+            "💡 Withdrawing this amount would leave your account with insufficient balance.\n"
+            "   Accounts must maintain a minimum balance to stay alive.\n"
+            "   Reduce the withdrawal amount and try again.",
+            title="❌ Balance Withdrawal Error",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Stake limit errors
+    elif "MinStakeNotReached" in error_msg:
+        error_panel = HTCLIPanel(
+            "Stake amount below minimum requirement.\n\n"
+            "💡 The stake amount must meet the subnet's minimum stake requirement.\n"
+            "   Check the subnet's min_stake parameter and increase your stake.\n"
+            "   For subnet nodes, you must maintain minimum stake even when removing.",
+            title="❌ Below Minimum Stake",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "MaxStakeReached" in error_msg:
+        error_panel = HTCLIPanel(
+            "Stake amount exceeds maximum limit.\n\n"
+            "💡 The stake amount exceeds the subnet's maximum stake limit.\n"
+            "   Check the subnet's max_stake parameter and reduce your stake.",
+            title="❌ Exceeds Maximum Stake",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Delegate stake errors
+    elif "MinDelegateStakeDepositNotReached" in error_msg:
+        error_panel = HTCLIPanel(
+            "Delegate stake deposit below minimum.\n\n"
+            "💡 The delegate stake amount must meet the minimum deposit requirement.\n"
+            "   Increase your delegate stake amount and try again.",
+            title="❌ Below Minimum Delegate Stake",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "MinNodeDelegateStakeDepositNotReached" in error_msg:
+        error_panel = HTCLIPanel(
+            "Node delegate stake deposit below minimum.\n\n"
+            "💡 The node delegate stake amount must meet the minimum deposit requirement.\n"
+            "   Increase your node delegate stake amount and try again.",
+            title="❌ Below Minimum Node Delegate Stake",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "MinDelegateStake" in error_msg:
+        error_panel = HTCLIPanel(
+            "Remaining delegate stake below minimum.\n\n"
+            "💡 After this operation, your remaining delegate stake would be below the minimum.\n"
+            "   Either remove all stake or keep enough to meet the minimum requirement.",
+            title="❌ Below Minimum Delegate Stake",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Unbonding/claiming errors
+    elif "NoStakeUnbondingsOrCooldownNotMet" in error_msg:
+        error_panel = HTCLIPanel(
+            "No stake available to claim.\n\n"
+            "💡 There are no unbonded stakes ready to claim, or the cooldown period hasn't ended.\n"
+            "   Stakes must complete the cooldown period before they can be claimed.\n"
+            "   Check your unbonding stakes: htcli stake list",
+            title="⏳ No Claimable Stakes",
+            border_style="htcli.warning",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "MaxUnlockingsReached" in error_msg:
+        error_panel = HTCLIPanel(
+            "Maximum unlockings reached.\n\n"
+            "💡 You've reached the maximum number of concurrent unbonding entries.\n"
+            "   Wait for some unbondings to complete before creating new ones.\n"
+            "   Check your unbonding stakes: htcli stake list",
+            title="❌ Maximum Unlockings Reached",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Validator restrictions
+    elif "ElectedValidatorCannotUnstake" in error_msg:
+        error_panel = HTCLIPanel(
+            "Cannot unstake - node is an elected validator.\n\n"
+            "💡 Elected validators cannot unstake during the current epoch.\n"
+            "   This ensures validators can be properly rewarded or penalized.\n"
+            "   Wait until the next epoch and try again.",
+            title="⚠️  Cannot Unstake Validator",
+            border_style="htcli.warning",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "MinActiveNodeStakeEpochs" in error_msg:
+        error_panel = HTCLIPanel(
+            "Minimum active stake epochs not met.\n\n"
+            "💡 Activated nodes must maintain stake for a minimum number of epochs.\n"
+            "   This ensures network stability and prevents rapid stake changes.\n"
+            "   Wait for the minimum stake period to complete before removing stake.",
+            title="⏳ Minimum Stake Period Not Met",
+            border_style="htcli.warning",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Subnet state errors
+    elif "SubnetMustBeActive" in error_msg:
+        error_panel = HTCLIPanel(
+            f"Subnet{subnet_id_str} must be active for this operation.\n\n"
+            f"💡 This operation requires the subnet to be in an active state.\n"
+            f"   Check subnet status: htcli subnet info --subnet-id{subnet_id_str}",
+            title="⚠️  Subnet Not Active",
+            border_style="htcli.warning",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "SubnetIsPaused" in error_msg:
+        error_panel = HTCLIPanel(
+            f"Subnet{subnet_id_str} is paused and cannot perform this action.\n\n"
+            f"💡 The subnet must be unpaused first.\n"
+            f"   Use: htcli subnet unpause --subnet-id{subnet_id_str}",
+            title="⏸️  Subnet Paused",
+            border_style="htcli.warning",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # =========================================================================
+    # GENERIC STAKING FALLBACK
+    # If we get here, the error was not specifically handled but it's still
+    # a staking operation. Show a helpful staking-specific error message
+    # instead of letting it fall through to the generic subnet error handler.
+    # =========================================================================
+    else:
+        # Format the raw error message to be more user-friendly
+        display_error = error_msg
+
+        # Try to extract the actual error name from substrate format
+        # e.g., "Module { index: 9, error: [0, 0, 0, 0], message: Some("SomeError") }"
+        if "message: Some(" in error_msg:
+            try:
+                import re
+
+                match = re.search(r'message: Some\("([^"]+)"\)', error_msg)
+                if match:
+                    display_error = match.group(1)
+            except Exception:
+                pass
+
+        error_panel = HTCLIPanel(
+            f"Staking {operation} failed.\\n\\n"
+            f"Error: {display_error}\\n\\n"
+            f"💡 Helpful Suggestions:\\n"
+            f"   • Check your balance: htcli wallet balance\\n"
+            f"   • Verify subnet exists: htcli subnet info --subnet-id{subnet_id_str}\\n"
+            + (
+                f"   • Verify node exists: htcli node info --subnet-id{subnet_id_str} --node-id{node_id_str}\\n"
+                if node_id_str
+                else ""
+            )
+            + f"   • Check your stake: htcli stake list\\n"
+            f"   • Review command help: htcli stake {operation.replace(' ', '-')} --help",
+            title=f"❌ Staking {operation.replace('_', ' ').title()} Failed",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True