htcli 1.1.0__py3-none-any.whl

src/htcli/models/requests/staking.py

@@ -0,0 +1,580 @@
+"""
+Staking request models for HTCLI.
+
+These models define the request structure for all staking operations
+on the Hypertensor blockchain.
+"""
+
+from pydantic import BaseModel, Field, validator
+
+# ============================================================================
+# DIRECT STAKING MODELS
+# ============================================================================
+
+
+class StakeAddRequest(BaseModel):
+    """Request to add stake to a subnet node."""
+
+    subnet_id: int = Field(..., description="Subnet ID to stake on")
+    subnet_node_id: int = Field(..., description="Subnet node ID to stake on")
+    hotkey: str = Field(..., description="Hotkey address of the subnet node")
+    stake_amount: int = Field(
+        ..., description="Amount to stake in wei (1e18 = 1 TENSOR)"
+    )
+
+    @validator("subnet_id")
+    def validate_subnet_id(cls, v):
+        if v < 0:
+            raise ValueError("Subnet ID must be non-negative")
+        return v
+
+    @validator("subnet_node_id")
+    def validate_subnet_node_id(cls, v):
+        if v < 0:
+            raise ValueError("Subnet node ID must be non-negative")
+        return v
+
+    @validator("hotkey")
+    def validate_hotkey(cls, v):
+        if not v or len(v) != 42 or not v.startswith("0x"):
+            raise ValueError("Hotkey must be a valid Ethereum address")
+        return v.lower()
+
+    @validator("stake_amount")
+    def validate_stake_amount(cls, v):
+        if v <= 0:
+            raise ValueError("Stake amount must be positive")
+        if v < 1e15:  # 0.001 TENSOR minimum
+            raise ValueError("Stake amount too small (minimum 0.001 TENSOR)")
+        return v
+
+
+class StakeRemoveRequest(BaseModel):
+    """Request to remove stake from a subnet node."""
+
+    subnet_id: int = Field(..., description="Subnet ID to remove stake from")
+    hotkey: str = Field(..., description="Hotkey address of the node")
+    stake_amount: int = Field(
+        ..., description="Amount to remove in wei (1e18 = 1 TENSOR)"
+    )
+
+    @validator("subnet_id")
+    def validate_subnet_id(cls, v):
+        if v < 0:
+            raise ValueError("Subnet ID must be non-negative")
+        return v
+
+    @validator("stake_amount")
+    def validate_stake_amount(cls, v):
+        if v <= 0:
+            raise ValueError("Stake amount must be positive")
+        return v
+
+
+class ClaimUnbondingsRequest(BaseModel):
+    """Request to claim unbonded stake."""
+
+    # No parameters needed - claims all available unbondings for the caller
+    pass
+
+
+# ============================================================================
+# DELEGATE STAKING MODELS
+# ============================================================================
+
+
+class DelegateStakeAddRequest(BaseModel):
+    """Request to add delegate stake to a subnet."""
+
+    subnet_id: int = Field(..., description="Subnet ID to delegate stake to")
+    stake_amount: int = Field(
+        ..., description="Amount to delegate in wei (1e18 = 1 TENSOR)"
+    )
+
+    @validator("subnet_id")
+    def validate_subnet_id(cls, v):
+        if v < 0:
+            raise ValueError("Subnet ID must be non-negative")
+        return v
+
+    @validator("stake_amount")
+    def validate_stake_amount(cls, v):
+        if v <= 0:
+            raise ValueError("Stake amount must be positive")
+        return v
+
+
+class DelegateStakeRemoveRequest(BaseModel):
+    """Request to remove delegate stake from a subnet."""
+
+    subnet_id: int = Field(..., description="Subnet ID to remove delegate stake from")
+    shares_to_be_removed: int = Field(
+        ..., description="Shares to remove (blockchain uses shares, not amounts)"
+    )
+
+    @validator("subnet_id")
+    def validate_subnet_id(cls, v):
+        if v < 0:
+            raise ValueError("Subnet ID must be non-negative")
+        return v
+
+    @validator("shares_to_be_removed")
+    def validate_shares(cls, v):
+        if v <= 0:
+            raise ValueError("Shares must be positive")
+        return v
+
+
+class DelegateStakeTransferRequest(BaseModel):
+    """Request to transfer delegate stake between accounts."""
+
+    subnet_id: int = Field(..., description="Subnet ID")
+    from_account: str = Field(..., description="Account to transfer from")
+    to_account: str = Field(..., description="Account to transfer to")
+    delegate_stake_shares_to_transfer: int = Field(
+        ..., description="Shares to transfer"
+    )
+
+    @validator("subnet_id")
+    def validate_subnet_id(cls, v):
+        if v < 0:
+            raise ValueError("Subnet ID must be non-negative")
+        return v
+
+    @validator("from_account", "to_account")
+    def validate_accounts(cls, v):
+        if not v or len(v) != 42 or not v.startswith("0x"):
+            raise ValueError("Account must be a valid Ethereum address")
+        return v.lower()
+
+    @validator("delegate_stake_shares_to_transfer")
+    def validate_shares(cls, v):
+        if v <= 0:
+            raise ValueError("Shares must be positive")
+        return v
+
+
+class DelegateStakeSwapRequest(BaseModel):
+    """Request to swap delegate stake between subnets."""
+
+    from_subnet_id: int = Field(..., description="Source subnet ID")
+    to_subnet_id: int = Field(..., description="Destination subnet ID")
+    delegate_stake_shares_to_swap: int = Field(..., description="Shares to swap")
+
+    @validator("from_subnet_id", "to_subnet_id")
+    def validate_subnet_ids(cls, v):
+        if v < 0:
+            raise ValueError("Subnet ID must be non-negative")
+        return v
+
+    @validator("delegate_stake_shares_to_swap")
+    def validate_shares(cls, v):
+        if v <= 0:
+            raise ValueError("Shares must be positive")
+        return v
+
+
+class DelegateStakeDonateRequest(BaseModel):
+    """Request to donate delegate stake to subnet treasury."""
+
+    subnet_id: int = Field(..., description="Subnet ID to donate to")
+    stake_amount: int = Field(..., description="Amount to donate in wei")
+
+    @validator("subnet_id")
+    def validate_subnet_id(cls, v):
+        if v < 0:
+            raise ValueError("Subnet ID must be non-negative")
+        return v
+
+    @validator("stake_amount")
+    def validate_stake_amount(cls, v):
+        if v <= 0:
+            raise ValueError("Stake amount must be positive")
+        return v
+
+
+# ============================================================================
+# VALIDATOR DELEGATE STAKING MODELS
+# ============================================================================
+
+
+class ValidatorDelegateStakeAddRequest(BaseModel):
+    """Request to add delegate stake to a validator."""
+
+    validator_id: int = Field(..., description="Validator ID to delegate to")
+    delegate_stake_to_be_added: int = Field(
+        ..., description="Amount to delegate in wei"
+    )
+
+    @validator("validator_id")
+    def validate_validator_id(cls, v):
+        if v < 0:
+            raise ValueError("Validator ID must be non-negative")
+        return v
+
+    @validator("delegate_stake_to_be_added")
+    def validate_stake_amount(cls, v):
+        if v <= 0:
+            raise ValueError("Stake amount must be positive")
+        return v
+
+
+class ValidatorDelegateStakeRemoveRequest(BaseModel):
+    """Request to remove delegate stake from a validator."""
+
+    validator_id: int = Field(..., description="Validator ID")
+    validator_delegate_stake_shares_to_be_removed: int = Field(
+        ..., description="Shares to remove"
+    )
+
+    @validator("validator_id")
+    def validate_validator_id(cls, v):
+        if v < 0:
+            raise ValueError("Validator ID must be non-negative")
+        return v
+
+    @validator("validator_delegate_stake_shares_to_be_removed")
+    def validate_shares(cls, v):
+        if v <= 0:
+            raise ValueError("Shares must be positive")
+        return v
+
+
+class ValidatorDelegateStakeTransferRequest(BaseModel):
+    """Request to transfer validator delegate stake shares to another account."""
+
+    validator_id: int = Field(..., description="Validator ID")
+    to_account_id: str = Field(..., description="Destination account")
+    validator_delegate_stake_shares_to_transfer: int = Field(
+        ..., description="Shares to transfer"
+    )
+
+    @validator("validator_id")
+    def validate_validator_id(cls, v):
+        if v < 0:
+            raise ValueError("Validator ID must be non-negative")
+        return v
+
+    @validator("to_account_id")
+    def validate_account(cls, v):
+        if not v or len(v) != 42 or not v.startswith("0x"):
+            raise ValueError("Account must be a valid Ethereum address")
+        return v.lower()
+
+    @validator("validator_delegate_stake_shares_to_transfer")
+    def validate_shares(cls, v):
+        if v <= 0:
+            raise ValueError("Shares must be positive")
+        return v
+
+
+class ValidatorDelegateStakeSwapRequest(BaseModel):
+    """Request to swap validator delegate stake between validators."""
+
+    from_validator_id: int = Field(..., description="Source validator ID")
+    to_validator_id: int = Field(..., description="Destination validator ID")
+    stake_to_be_removed: int = Field(..., description="Shares to swap")
+
+    @validator("from_validator_id", "to_validator_id")
+    def validate_validator_ids(cls, v):
+        if v < 0:
+            raise ValueError("Validator ID must be non-negative")
+        return v
+
+    @validator("stake_to_be_removed")
+    def validate_shares(cls, v):
+        if v <= 0:
+            raise ValueError("Shares must be positive")
+        return v
+
+
+class ValidatorDelegateStakeDonateRequest(BaseModel):
+    """Request to donate to a validator delegate stake pool."""
+
+    validator_id: int = Field(..., description="Validator ID")
+    amount: int = Field(..., description="Amount to donate in wei")
+
+    @validator("validator_id")
+    def validate_validator_id(cls, v):
+        if v < 0:
+            raise ValueError("Validator ID must be non-negative")
+        return v
+
+    @validator("amount")
+    def validate_stake_amount(cls, v):
+        if v <= 0:
+            raise ValueError("Stake amount must be positive")
+        return v
+
+
+# ============================================================================
+# NODE DELEGATE STAKING MODELS
+# ============================================================================
+
+
+class NodeDelegateStakeAddRequest(BaseModel):
+    """Request to add delegate stake to a specific node."""
+
+    subnet_id: int = Field(..., description="Subnet ID")
+    subnet_node_id: int = Field(..., description="Subnet node ID to delegate to")
+    node_delegate_stake_to_be_added: int = Field(
+        ..., description="Amount to delegate in wei (blockchain parameter name)"
+    )
+
+    @validator("subnet_id", "subnet_node_id")
+    def validate_ids(cls, v):
+        if v < 0:
+            raise ValueError("ID must be non-negative")
+        return v
+
+    @validator("node_delegate_stake_to_be_added")
+    def validate_stake_amount(cls, v):
+        if v <= 0:
+            raise ValueError("Stake amount must be positive")
+        return v
+
+
+class NodeDelegateStakeRemoveRequest(BaseModel):
+    """Request to remove delegate stake from a specific node."""
+
+    subnet_id: int = Field(..., description="Subnet ID")
+    subnet_node_id: int = Field(
+        ..., description="Subnet node ID to remove delegate stake from"
+    )
+    node_delegate_stake_shares_to_be_removed: int = Field(
+        ..., description="Shares to remove (blockchain uses shares, not amounts)"
+    )
+
+    @validator("subnet_id", "subnet_node_id")
+    def validate_ids(cls, v):
+        if v < 0:
+            raise ValueError("ID must be non-negative")
+        return v
+
+    @validator("node_delegate_stake_shares_to_be_removed")
+    def validate_shares(cls, v):
+        if v <= 0:
+            raise ValueError("Shares must be positive")
+        return v
+
+
+class NodeDelegateStakeTransferRequest(BaseModel):
+    """Request to transfer node delegate stake shares to another account."""
+
+    subnet_id: int = Field(..., description="Subnet ID")
+    subnet_node_id: int = Field(..., description="Subnet node ID")
+    to_account_id: str = Field(..., description="Destination account")
+    node_delegate_stake_shares_to_transfer: int = Field(
+        ..., description="Shares to transfer (not wei amount)"
+    )
+
+    @validator("subnet_id", "subnet_node_id")
+    def validate_ids(cls, v):
+        if v < 0:
+            raise ValueError("ID must be non-negative")
+        return v
+
+    @validator("to_account_id")
+    def validate_account(cls, v):
+        if not v or len(v) != 42 or not v.startswith("0x"):
+            raise ValueError("Account must be a valid Ethereum address")
+        return v.lower()
+
+    @validator("node_delegate_stake_shares_to_transfer")
+    def validate_shares(cls, v):
+        if v <= 0:
+            raise ValueError("Shares must be positive")
+        return v
+
+
+class NodeDelegateStakeSwapRequest(BaseModel):
+    """Request to swap node delegate stake between nodes."""
+
+    from_subnet_id: int = Field(..., description="Source subnet ID")
+    from_subnet_node_id: int = Field(..., description="Source subnet node ID")
+    to_subnet_id: int = Field(..., description="Destination subnet ID")
+    to_subnet_node_id: int = Field(..., description="Destination subnet node ID")
+    node_delegate_stake_shares_to_swap: int = Field(
+        ..., description="Shares to swap (not amount)"
+    )
+
+    @validator(
+        "from_subnet_id", "from_subnet_node_id", "to_subnet_id", "to_subnet_node_id"
+    )
+    def validate_ids(cls, v):
+        if v < 0:
+            raise ValueError("ID must be non-negative")
+        return v
+
+    @validator("node_delegate_stake_shares_to_swap")
+    def validate_shares(cls, v):
+        if v <= 0:
+            raise ValueError("Shares must be positive")
+        return v
+
+
+class NodeDelegateStakeDonateRequest(BaseModel):
+    """Request to donate node delegate stake to node treasury."""
+
+    subnet_id: int = Field(..., description="Subnet ID")
+    subnet_node_id: int = Field(..., description="Subnet node ID to donate to")
+    amount: int = Field(..., description="Amount to donate in wei")
+
+    @validator("subnet_id", "subnet_node_id")
+    def validate_ids(cls, v):
+        if v < 0:
+            raise ValueError("ID must be non-negative")
+        return v
+
+    @validator("amount")
+    def validate_stake_amount(cls, v):
+        if v <= 0:
+            raise ValueError("Stake amount must be positive")
+        return v
+
+
+# ============================================================================
+# CROSS-STAKE SWAP MODELS
+# ============================================================================
+
+
+class StakeSwapFromNodeToSubnetRequest(BaseModel):
+    """Request to swap stake from node delegate to subnet delegate."""
+
+    from_subnet_id: int = Field(..., description="Source subnet ID")
+    from_subnet_node_id: int = Field(..., description="Source node ID")
+    to_subnet_id: int = Field(..., description="Destination subnet ID")
+    node_delegate_stake_shares_to_swap: int = Field(
+        ..., description="Shares to convert from node to subnet"
+    )
+
+    @validator("from_subnet_id", "from_subnet_node_id", "to_subnet_id")
+    def validate_ids(cls, v):
+        if v < 0:
+            raise ValueError("ID must be non-negative")
+        return v
+
+    @validator("node_delegate_stake_shares_to_swap")
+    def validate_shares(cls, v):
+        if v <= 0:
+            raise ValueError("Shares must be positive")
+        return v
+
+
+class StakeSwapFromSubnetToNodeRequest(BaseModel):
+    """Request to swap stake from subnet delegate to node delegate."""
+
+    from_subnet_id: int = Field(..., description="Source subnet ID")
+    to_subnet_id: int = Field(..., description="Destination subnet ID")
+    to_subnet_node_id: int = Field(..., description="Destination node ID")
+    delegate_stake_shares_to_swap: int = Field(
+        ..., description="Shares to convert from subnet to node"
+    )
+
+    @validator("from_subnet_id", "to_subnet_id", "to_subnet_node_id")
+    def validate_ids(cls, v):
+        if v < 0:
+            raise ValueError("ID must be non-negative")
+        return v
+
+    @validator("delegate_stake_shares_to_swap")
+    def validate_shares(cls, v):
+        if v <= 0:
+            raise ValueError("Shares must be positive")
+        return v
+
+
+class StakeSwapFromValidatorToSubnetRequest(BaseModel):
+    """Request to swap stake from validator delegate to subnet delegate."""
+
+    from_validator_id: int = Field(..., description="Source validator ID")
+    to_subnet_id: int = Field(..., description="Destination subnet ID")
+    node_delegate_stake_shares_to_swap: int = Field(
+        ..., description="Validator delegate shares to convert to subnet delegate"
+    )
+
+    @validator("from_validator_id", "to_subnet_id")
+    def validate_ids(cls, v):
+        if v < 0:
+            raise ValueError("ID must be non-negative")
+        return v
+
+    @validator("node_delegate_stake_shares_to_swap")
+    def validate_shares(cls, v):
+        if v <= 0:
+            raise ValueError("Shares must be positive")
+        return v
+
+
+class StakeSwapFromSubnetToValidatorRequest(BaseModel):
+    """Request to swap stake from subnet delegate to validator delegate."""
+
+    from_subnet_id: int = Field(..., description="Source subnet ID")
+    to_validator_id: int = Field(..., description="Destination validator ID")
+    subnet_delegate_stake_shares_to_swap: int = Field(
+        ..., description="Subnet delegate shares to convert to validator delegate"
+    )
+
+    @validator("from_subnet_id", "to_validator_id")
+    def validate_ids(cls, v):
+        if v < 0:
+            raise ValueError("ID must be non-negative")
+        return v
+
+    @validator("subnet_delegate_stake_shares_to_swap")
+    def validate_shares(cls, v):
+        if v <= 0:
+            raise ValueError("Shares must be positive")
+        return v
+
+
+class StakeSwapQueueUpdateRequest(BaseModel):
+    """Request to update stake swap queue."""
+
+    queue_id: int = Field(..., description="Queue entry ID to update")
+    new_call: dict = Field(
+        ..., description="Replacement call payload (QueuedSwapCall JSON structure)"
+    )
+
+    @validator("queue_id")
+    def validate_queue_id(cls, v):
+        if v < 0:
+            raise ValueError("Queue ID must be non-negative")
+        return v
+
+    @validator("new_call")
+    def validate_new_call(cls, v):
+        if not isinstance(v, dict):
+            raise ValueError("new_call must be a JSON object")
+        if not v:
+            raise ValueError("new_call cannot be empty")
+        return v
+
+
+# ============================================================================
+# OVERWATCH STAKING MODELS
+# ============================================================================
+
+
+class OverwatchStakeAddRequest(BaseModel):
+    """Request to add stake to overwatch nodes."""
+
+    stake_amount: int = Field(..., description="Amount to stake in wei")
+
+    @validator("stake_amount")
+    def validate_stake_amount(cls, v):
+        if v <= 0:
+            raise ValueError("Stake amount must be positive")
+        return v
+
+
+class OverwatchStakeRemoveRequest(BaseModel):
+    """Request to remove stake from overwatch nodes."""
+
+    stake_amount: int = Field(..., description="Amount to remove in wei")
+
+    @validator("stake_amount")
+    def validate_stake_amount(cls, v):
+        if v <= 0:
+            raise ValueError("Stake amount must be positive")
+        return v