htcli 1.1.0__py3-none-any.whl

src/htcli/commands/node/error_handling.py

@@ -0,0 +1,470 @@
+"""
+Error handling utilities for subnet node commands.
+Provides user-friendly error messages for all subnet node-related errors.
+"""
+
+from typing import Optional
+
+from ...ui.components import HTCLIPanel
+from ...ui.display import HTCLIConsole
+
+
+def handle_node_error(
+    error_msg: str,
+    subnet_id: Optional[int] = None,
+    subnet_node_id: Optional[int] = None,
+    operation: str = "operation",
+    client=None,
+) -> bool:
+    """
+    Handle subnet node-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
+
+    # Common errors that apply to most operations
+    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(
+            f"You are not the owner of this subnet node{node_id_str}.\n\n"
+            f"💡 Make sure you're using the correct coldkey or hotkey wallet.\n"
+            f"   Only the node owner (coldkey or hotkey) can perform this operation.\n"
+            f"   Check node ownership: htcli node info --subnet-id{subnet_id_str} --node-id{node_id_str}",
+            title="❌ Permission Denied",
+            border_style="htcli.error",
+            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
+
+    elif "SubnetMustBeRegisteringOrActivated" in error_msg:
+        error_panel = HTCLIPanel(
+            f"Cannot register node to subnet{subnet_id_str} during enactment period.\n\n"
+            f"💡 Node registration is blocked during the enactment period.\n"
+            f"   Nodes can only be registered during:\n"
+            f"   - Registration period (before activation)\n"
+            f"   - Active state (after activation)\n\n"
+            f"   Wait for the enactment period to end and try again.",
+            title="⚠️  Registration Blocked",
+            border_style="htcli.warning",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Registration-specific errors
+    elif "ColdkeyMatchesHotkey" in error_msg:
+        error_panel = HTCLIPanel(
+            "Coldkey and hotkey must be different.\n\n"
+            "💡 For security reasons, the coldkey and hotkey cannot be the same account.\n"
+            "   Use different accounts for coldkey (owner) and hotkey (node operator).",
+            title="❌ Invalid Key Configuration",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "HotkeyHasOwner" in error_msg:
+        error_panel = HTCLIPanel(
+            "This hotkey is already in use by another node.\n\n"
+            "💡 Each hotkey can only operate one node across the entire network.\n"
+            "   Use a different hotkey that is not already registered.",
+            title="❌ Hotkey Already In Use",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "HotkeyAlreadyRegisteredToColdkey" in error_msg:
+        error_panel = HTCLIPanel(
+            "This hotkey is already registered to your coldkey.\n\n"
+            "💡 You cannot register the same hotkey twice.\n"
+            "   Use a different hotkey for this node.",
+            title="❌ Hotkey Already Registered",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "PeerIdsMustBeUnique" in error_msg:
+        error_panel = HTCLIPanel(
+            "Peer IDs must be unique from each other.\n\n"
+            "💡 The peer_id, bootnode_peer_id, and client_peer_id must all be different.\n"
+            "   Each peer ID serves a different network function and must be distinct.",
+            title="❌ Duplicate Peer IDs",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "InvalidPeerId" in error_msg:
+        error_panel = HTCLIPanel(
+            "Invalid peer ID format.\n\n"
+            "💡 Peer IDs must be valid libp2p format (base58-encoded).\n"
+            "   Check your peer ID format and try again.",
+            title="❌ Invalid Peer ID",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "InvalidBootnodePeerId" in error_msg:
+        error_panel = HTCLIPanel(
+            "Invalid bootnode peer ID format.\n\n"
+            "💡 Bootnode peer IDs must be valid libp2p format (base58-encoded).\n"
+            "   Check your bootnode peer ID format and try again.",
+            title="❌ Invalid Bootnode Peer ID",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "InvalidClientPeerId" in error_msg:
+        error_panel = HTCLIPanel(
+            "Invalid client peer ID format.\n\n"
+            "💡 Client peer IDs must be valid libp2p format (base58-encoded).\n"
+            "   Check your client peer ID format and try again.",
+            title="❌ Invalid Client Peer ID",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "PeerIdExist" in error_msg:
+        error_panel = HTCLIPanel(
+            f"This peer ID is already in use in subnet{subnet_id_str}.\n\n"
+            f"💡 Peer IDs must be unique within each subnet.\n"
+            f"   Use a different peer ID that is not already registered.",
+            title="❌ Peer ID Already Exists",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "BootnodePeerIdExist" in error_msg:
+        error_panel = HTCLIPanel(
+            f"This bootnode peer ID is already in use in subnet{subnet_id_str}.\n\n"
+            f"💡 Bootnode peer IDs must be unique within each subnet.\n"
+            f"   Use a different bootnode peer ID that is not already registered.",
+            title="❌ Bootnode Peer ID Already Exists",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "ClientPeerIdExist" in error_msg:
+        error_panel = HTCLIPanel(
+            f"This client peer ID is already in use in subnet{subnet_id_str}.\n\n"
+            f"💡 Client peer IDs must be unique within each subnet.\n"
+            f"   Use a different client peer ID that is not already registered.",
+            title="❌ Client Peer ID Already Exists",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "BootnodeExist" in error_msg:
+        error_panel = HTCLIPanel(
+            f"This bootnode multiaddr is already in use in subnet{subnet_id_str}.\n\n"
+            f"💡 Bootnode multiaddrs must be unique within each subnet.\n"
+            f"   Use a different bootnode multiaddr that is not already registered.",
+            title="❌ Bootnode Already Exists",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "ColdkeyRegistrationWhitelist" in error_msg:
+        error_panel = HTCLIPanel(
+            "Your coldkey is not whitelisted for node registration.\n\n"
+            "💡 During the subnet registration period, only whitelisted coldkeys can register nodes.\n"
+            "   Contact the subnet owner to get your coldkey added to the whitelist.",
+            title="❌ Not Whitelisted",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "MaxRegisteredNodes" in error_msg:
+        error_panel = HTCLIPanel(
+            f"Subnet{subnet_id_str} has reached maximum node capacity.\n\n"
+            f"💡 The subnet has reached its maximum number of registered nodes.\n"
+            f"   Wait for a node slot to become available or check if any nodes can be removed.",
+            title="❌ Subnet at Capacity",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "MaxSubnetNodes" in error_msg:
+        error_panel = HTCLIPanel(
+            "Maximum subnet nodes reached.\n\n"
+            "💡 The subnet has reached its maximum node limit.\n"
+            "   Wait for nodes to be removed or check subnet capacity.",
+            title="❌ Maximum Nodes Reached",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "SubnetNodeUniqueParamTaken" in error_msg or "UniqueParameterTaken" in error_msg:
+        error_panel = HTCLIPanel(
+            f"This unique parameter is already in use in subnet{subnet_id_str}.\n\n"
+            f"💡 Unique parameters must be unique within each subnet.\n"
+            f"   Use a different unique parameter value.",
+            title="❌ Unique Parameter Already Taken",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "MaxBurnAmountExceeded" in error_msg:
+        error_panel = HTCLIPanel(
+            "Registration burn cost exceeds your maximum amount limit.\n\n"
+            "💡 The current registration burn cost is higher than your max_burn_amount.\n"
+            "   This protects you from unexpected cost increases.\n"
+            "   Increase your max_burn_amount parameter or wait for costs to decrease.",
+            title="❌ Burn Cost Exceeds Maximum",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "BalanceBurnError" in error_msg:
+        error_panel = HTCLIPanel(
+            "Insufficient balance to pay registration burn fee.\n\n"
+            "💡 You don't have enough balance to cover the registration burn cost.\n"
+            "   Ensure your wallet has sufficient funds and try again.\n"
+            "   Check your balance: htcli wallet balance",
+            title="❌ Insufficient Balance for Burn",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    elif "MustUnstakeToRegister" in error_msg:
+        error_panel = HTCLIPanel(
+            "You must unstake before registering a node.\n\n"
+            "💡 This hotkey has existing stake that must be unstaked first.\n"
+            "   Unstake your existing stake, then try registering again.\n"
+            "   Use: htcli stake unstake to remove your stake",
+            title="❌ Must Unstake First",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Removal-specific errors
+    elif "ElectedValidatorCannotRemove" in error_msg:
+        error_panel = HTCLIPanel(
+            f"Cannot remove node{node_id_str} - it is an elected validator.\n\n"
+            f"💡 Elected validators cannot be removed during the current epoch.\n"
+            f"   This ensures validators can be properly rewarded or penalized.\n"
+            f"   Wait until the next epoch and try again.",
+            title="⚠️  Cannot Remove Validator",
+            border_style="htcli.warning",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Delegate reward rate errors
+    elif "InvalidDelegateRewardRate" in error_msg:
+        error_panel = HTCLIPanel(
+            "Invalid delegate reward rate.\n\n"
+            "💡 Delegate reward rate must be:\n"
+            "   - Between 0% and 100% (0 to percentage_factor_as_u128)\n"
+            "   - Not exceed MaxDelegateStakePercentage\n\n"
+            "   Use a valid reward rate and try again.",
+            title="❌ Invalid Reward Rate",
+            border_style="htcli.error",
+            highlight=True,
+        )
+        error_panel.render(console.console)
+        return True
+
+    # Staking errors (from do_add_stake)
+    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 "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.",
+            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
+
+    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 "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 "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
+
+    return False  # Error not handled by this function
+