iwa 0.0.0__py3-none-any.whl → 0.0.1a2__py3-none-any.whl

iwa/plugins/olas/mech_reference.py

@@ -0,0 +1,135 @@
+"""Olas Mech Ecosystem - Contract Reference
+
+This module documents all mech and marketplace contracts in the Olas ecosystem
+and their relationship with activity checkers for staking rewards.
+
+=============================================================================
+MECH CONTRACTS
+=============================================================================
+
+1. LEGACY MECH (Direct Requests)
+   Address: 0x77af31De935740567Cf4fF1986D04B2c964A786a
+   ABI: mech.json
+   Usage: Direct requests via request() -> deliver()
+   Functions:
+     - request(data) -> requestId
+     - deliver(requestId, data)
+     - getRequestsCount(multisig) -> count  # Used by legacy activity checker
+
+2. MARKETPLACE MECHS (Via MechMarketplace)
+   Address: 0x601024E27f1C67B28209E24272CED8A31fc8151F (Priority Mech)
+   ABI: mech_new.json
+   Usage: Requests via MechMarketplace.request() -> mech.deliverToMarketplace()
+   Functions:
+     - requestFromMarketplace(...) -> called by marketplace
+     - deliverToMarketplace(...) -> delivers via marketplace
+     - mechMarketplace -> address of associated marketplace
+     - NO getRequestsCount() - tracking done by marketplace
+
+
+=============================================================================
+MARKETPLACE CONTRACTS
+=============================================================================
+
+1. OLD MECH MARKETPLACE (v1 / Beta)
+   Address: 0x4554fE75c1f5576c1d7F765B2A036c199Adae329
+   Total Requests: ~1.87M
+   Used by: Pearl Beta Marketplace activity checker (0x7Ec96996Cd...)
+   Status: LEGACY / DEPRECATED
+
+2. NEW MECH MARKETPLACE (v2 / Current)
+   Address: 0x735FAAb1c4Ec41128c367AFb5c3baC73509f70bB
+   Total Requests: ~782K
+   ABI: mech_marketplace.json
+   Status: ACTIVE / CURRENT
+   Note: This is the one we use in ServiceManager.send_mech_request()
+
+
+=============================================================================
+ACTIVITY CHECKERS
+=============================================================================
+
+Activity checkers determine which requests count for staking liveness rewards.
+
+1. LEGACY ACTIVITY CHECKER (MechActivityChecker)
+   Address: 0x87E6a97bD97D41904B1125A014B16bec50C6A89D
+   Tracks: agentMech.getRequestsCount(multisig)
+   Mech: 0x77af31De... (Legacy Mech)
+   Used by: ALL TRADER staking contracts (Hobbyist, Expert 1-18)
+   Effect: ONLY Legacy mech requests count for rewards
+
+2. MARKETPLACE ACTIVITY CHECKER (MechMarketplaceActivityChecker)
+   Address: 0x7Ec96996Cd146B91779f01419db42E67463817a0
+   Tracks: mechMarketplace.getRequestsCount(multisig) (OLD marketplace)
+   Marketplace: 0x4554fE75... (OLD Marketplace)
+   Used by: Pearl Beta - Mech Marketplace staking contract
+   Effect: ONLY OLD marketplace requests count (NOT the new marketplace!)
+
+
+=============================================================================
+STAKING CONTRACT COMPATIBILITY
+=============================================================================
+
+| Staking Contract      | Min OLAS | Activity Checker | Requests That Count |
+|-----------------------|----------|------------------|---------------------|
+| Hobbyist 1-2          | 50-250   | Legacy           | Legacy mech only    |
+| Expert 1-18           | 100-500  | Legacy           | Legacy mech only    |
+| Pearl Beta Marketplace| 20       | Marketplace      | OLD marketplace only|
+
+
+=============================================================================
+STAKING DEPOSIT + BOND MECHANICS
+=============================================================================
+
+When staking a service, the TOTAL OLAS required is split 50/50:
+
+  minStakingDeposit: Goes to the staking contract as collateral
+  agentBond:         Goes to Token Utility as operator bond
+
+Example for Hobbyist 1 (100 OLAS total):
+  - minStakingDeposit: 50 OLAS (stored in staking contract)
+  - agentBond: 50 OLAS (stored in Token Utility for agent ID)
+  - Total: 100 OLAS
+
+Both are stored in the Token Utility contract:
+  - mapServiceIdTokenDeposit(serviceId) -> (token, deposit)
+  - getAgentBond(serviceId, agentId) -> bond
+
+| Contract Name         | Min Deposit | Agent Bond | Total OLAS |
+|-----------------------|-------------|------------|------------|
+| Hobbyist 1 (100 OLAS) | 50          | 50         | 100        |
+| Hobbyist 2 (500 OLAS) | 250         | 250        | 500        |
+| Expert (1k OLAS)      | 500         | 500        | 1000       |
+| Expert 3 (2k OLAS)    | 1000        | 1000       | 2000       |
+| Expert 4+ (10k OLAS)  | 5000        | 5000       | 10000      |
+
+
+=============================================================================
+IMPORTANT FINDINGS
+=============================================================================
+
+⚠️ The NEW marketplace (0x735FAAb1...) that we use has NO STAKING CONTRACT
+   that tracks its requests for liveness rewards yet!
+
+⚠️ For TRADER staking rewards, you MUST use use_marketplace=False
+
+⚠️ Pearl Beta Mech Marketplace uses the OLD marketplace, not the new one
+
+"""
+
+# Export contract addresses for easy reference
+MECH_ECOSYSTEM = {
+    "gnosis": {
+        # Mech contracts
+        "legacy_mech": "0x77af31De935740567Cf4fF1986D04B2c964A786a",
+        "priority_mech": "0x601024E27f1C67B28209E24272CED8A31fc8151F",
+        # Marketplace contracts
+        "old_marketplace": "0x4554fE75c1f5576c1d7F765B2A036c199Adae329",  # v1, deprecated
+        "new_marketplace": "0x735FAAb1c4Ec41128c367AFb5c3baC73509f70bB",  # v2, current
+        # Activity checkers
+        "legacy_activity_checker": "0x87E6a97bD97D41904B1125A014B16bec50C6A89D",
+        "marketplace_activity_checker": "0x7Ec96996Cd146B91779f01419db42E67463817a0",
+        # Staking with marketplace support (uses OLD marketplace)
+        "pearl_beta_marketplace_staking": "0xDaF34eC46298b53a3d24CBCb431E84eBd23927dA",
+    }
+}

iwa/plugins/olas/models.py

@@ -0,0 +1,110 @@
+"""Olas models"""
+
+from typing import Dict, List, Optional
+
+from pydantic import BaseModel, Field
+
+from iwa.core.models import EthereumAddress
+
+
+class Service(BaseModel):
+    """Service model for OLAS services."""
+
+    service_name: str  # Human-readable name
+    chain_name: str
+    service_id: int  # Unique per chain
+    agent_ids: List[int] = Field(default_factory=list)  # List of agent type IDs
+    service_owner_address: Optional[EthereumAddress] = None
+    agent_address: Optional[EthereumAddress] = None
+    multisig_address: Optional[EthereumAddress] = None
+    staking_contract_address: Optional[EthereumAddress] = None
+    token_address: Optional[EthereumAddress] = None
+
+    @property
+    def key(self) -> str:
+        """Unique key for this service (chain_name:service_id)."""
+        return f"{self.chain_name}:{self.service_id}"
+
+
+class StakingStatus(BaseModel):
+    """Staking status for a service including liveness check info.
+
+    The activity checker tracks:
+    - safe_nonce: Total Safe multisig transactions
+    - mech_requests: Total mech requests made
+
+    Liveness is measured by mech_requests made since last checkpoint.
+    """
+
+    is_staked: bool
+    staking_contract_address: Optional[str] = None
+    staking_contract_name: Optional[str] = None
+    staking_state: str  # "NOT_STAKED", "STAKED", "EVICTED"
+
+    # Mech request tracking (what determines liveness)
+    mech_requests_this_epoch: int = 0
+    required_mech_requests: int = 0
+    remaining_mech_requests: int = 0
+    has_enough_requests: bool = False
+    liveness_ratio_passed: bool = False
+
+    # Rewards
+    accrued_reward_wei: int = 0
+    accrued_reward_olas: float = 0
+
+    # Epoch timing
+    epoch_number: int = 0
+    epoch_end_utc: Optional[str] = None  # ISO format string
+    remaining_epoch_seconds: float = 0
+
+    # Activity checker info
+    activity_checker_address: Optional[str] = None
+    liveness_ratio: int = 0  # Requests per second * 1e18
+
+    # Unstake timing
+    ts_start: int = 0
+    min_staking_duration: int = 0
+    unstake_available_at: Optional[str] = None  # ISO format string
+
+
+class OlasConfig(BaseModel):
+    """OlasConfig with multi-service support."""
+
+    # Dict keyed by service key (chain_name:service_id)
+    services: Dict[str, Service] = Field(default_factory=dict)
+
+    # Address to send claimed OLAS rewards to
+    withdrawal_address: Optional[EthereumAddress] = None
+
+    def add_service(self, service: Service) -> None:
+        """Add or update a service."""
+        self.services[service.key] = service
+
+    def remove_service(self, key: str) -> bool:
+        """Remove a service by key."""
+        if key in self.services:
+            del self.services[key]
+            return True
+        return False
+
+    def get_service(self, chain_name: str, service_id: int) -> Optional[Service]:
+        """Get a specific service by chain and ID."""
+        key = f"{chain_name}:{service_id}"
+        return self.services.get(key)
+
+    def get_service_by_multisig(self, multisig_address: str) -> Optional[Service]:
+        """Get a service by its multisig (Safe) address.
+
+        Args:
+            multisig_address: The Safe multisig address.
+
+        Returns:
+            Service if found, None otherwise.
+
+        """
+        # Normalize address for comparison
+        target = multisig_address.lower()
+        for service in self.services.values():
+            if service.multisig_address and str(service.multisig_address).lower() == target:
+                return service
+        return None

iwa/plugins/olas/plugin.py

@@ -0,0 +1,243 @@
+"""Olas plugin."""
+
+from pathlib import Path
+from typing import Dict, Optional, Type
+
+import typer
+from pydantic import BaseModel
+
+from iwa.core.plugins import Plugin
+from iwa.core.wallet import Wallet
+from iwa.plugins.olas.models import OlasConfig
+from iwa.plugins.olas.service_manager import ServiceManager
+
+
+class OlasPlugin(Plugin):
+    """Olas Plugin."""
+
+    @property
+    def name(self) -> str:
+        """Get plugin name."""
+        return "olas"
+
+    @property
+    def config_model(self) -> Type[BaseModel]:
+        """Get config model."""
+        return OlasConfig
+
+    def get_cli_commands(self) -> Dict[str, callable]:
+        """Get CLI commands."""
+        return {
+            "create": self.create_service,
+            "import": self.import_services,
+        }
+
+    def get_tui_view(self, wallet=None):
+        """Get TUI widget for this plugin."""
+        from iwa.plugins.olas.tui.olas_view import OlasView
+
+        return OlasView(wallet=wallet)
+
+    def create_service(
+        self,
+        chain_name: str = typer.Option("gnosis", "--chain", "-c"),
+        owner: Optional[str] = typer.Option(None, "--owner", "-o"),
+        token: Optional[str] = typer.Option(None, "--token"),
+        bond: int = typer.Option(1, "--bond", "-b"),
+    ):
+        """Create a new Olas service"""
+        wallet = Wallet()
+        manager = ServiceManager(wallet)
+        # Note: Manager logic currently depends on internal config state which might need setup
+        manager.create(chain_name, owner, token, bond)
+
+    def _get_safe_signers(self, safe_address: str, chain_name: str) -> tuple:
+        """Query Safe signers on-chain.
+
+        Returns:
+            Tuple of (signers_list, safe_exists):
+            - (list, True) if Safe exists and query succeeds
+            - ([], False) if Safe doesn't exist on-chain
+            - (None, None) if RPC not configured (skip verification)
+
+        """
+        try:
+            from safe_eth.eth import EthereumClient
+            from safe_eth.safe import Safe
+
+            from iwa.core.settings import settings
+
+            rpc_secret = getattr(settings, f"{chain_name}_rpc", None)
+            if not rpc_secret:
+                return None, None  # Can't verify, skip
+
+            ethereum_client = EthereumClient(rpc_secret.get_secret_value())
+            safe = Safe(safe_address, ethereum_client)
+            owners = safe.retrieve_owners()
+            return owners, True
+        except Exception:
+            # Query failed - Safe likely doesn't exist
+            return [], False
+
+    def _display_service_table(self, console, service, index: int) -> None:
+        """Display a single discovered service as a Rich table."""
+        from rich.table import Table
+
+        table = Table(
+            title=f"Service {index}: {service.service_name or 'Unknown'}", show_header=False
+        )
+        table.add_column("Property", style="cyan")
+        table.add_column("Value")
+
+        table.add_row("Format", service.format)
+        table.add_row("Source", str(service.source_folder))
+        table.add_row("Service ID", str(service.service_id) if service.service_id else "N/A")
+        table.add_row("Chain", service.chain_name)
+
+        # Verify Safe and display
+        on_chain_signers, safe_exists = None, None
+        if service.safe_address:
+            on_chain_signers, safe_exists = self._get_safe_signers(
+                service.safe_address, service.chain_name
+            )
+            if safe_exists is None:
+                table.add_row("Safe", service.safe_address)
+            elif safe_exists:
+                table.add_row("Safe", f"{service.safe_address} [green]✓[/green]")
+            else:
+                table.add_row(
+                    "Safe",
+                    f"[bold red]⚠ {service.safe_address} - DOES NOT EXIST ON-CHAIN![/bold red]",
+                )
+        else:
+            table.add_row("Safe", "N/A")
+
+        # Display keys with signer verification
+        for key in service.keys:
+            status = "🔒 encrypted" if key.is_encrypted else "🔓 plaintext"
+            key_info = f"{key.address} {status}"
+
+            if key.role == "agent" and service.safe_address:
+                if not safe_exists:
+                    key_info = f"[bold red]⚠ {key.address} - NOT A SIGNER OF THE SAFE![/bold red]"
+                elif on_chain_signers is not None:
+                    is_signer = key.address.lower() in [s.lower() for s in on_chain_signers]
+                    if not is_signer:
+                        key_info = (
+                            f"[bold red]⚠ {key.address} - NOT A SIGNER OF THE SAFE![/bold red]"
+                        )
+
+            table.add_row(f"Key ({key.role})", key_info)
+
+        console.print(table)
+        console.print()
+
+    def _import_and_print_results(self, console, importer, discovered, password) -> tuple:
+        """Import all discovered services and print results."""
+        total_keys = 0
+        total_safes = 0
+        total_services = 0
+        all_skipped = []
+        all_errors = []
+
+        for service in discovered:
+            console.print(
+                f"\n[bold]Importing[/bold] {service.service_name or service.source_folder}..."
+            )
+            result = importer.import_service(service, password)
+
+            total_keys += len(result.imported_keys)
+            total_safes += len(result.imported_safes)
+            total_services += len(result.imported_services)
+            all_skipped.extend(result.skipped)
+            all_errors.extend(result.errors)
+
+            if result.imported_keys:
+                console.print(
+                    f"  [green]✓[/green] Imported keys: {', '.join(result.imported_keys)}"
+                )
+            if result.imported_safes:
+                console.print(
+                    f"  [green]✓[/green] Imported safes: {', '.join(result.imported_safes)}"
+                )
+            if result.imported_services:
+                console.print(
+                    f"  [green]✓[/green] Imported services: {', '.join(result.imported_services)}"
+                )
+            if result.skipped:
+                for item in result.skipped:
+                    console.print(f"  [yellow]⊘[/yellow] Skipped: {item}")
+            if result.errors:
+                for error in result.errors:
+                    console.print(f"  [red]✗[/red] Error: {error}")
+
+        return total_keys, total_safes, total_services, all_skipped, all_errors
+
+    def import_services(
+        self,
+        path: str = typer.Argument(..., help="Directory to scan for Olas services"),
+        dry_run: bool = typer.Option(
+            False, "--dry-run", "-n", help="Show what would be imported without making changes"
+        ),
+        password: Optional[str] = typer.Option(
+            None, "--password", "-p", help="Password for encrypted keys (will prompt if needed)"
+        ),
+        yes: bool = typer.Option(
+            False, "--yes", "-y", help="Import all without confirmation prompts"
+        ),
+    ):
+        """Import Olas services and keys from external directories."""
+        from rich.console import Console
+
+        from iwa.plugins.olas.importer import OlasServiceImporter
+
+        console = Console()
+
+        # Scan directory
+        console.print(f"\n[bold]Scanning[/bold] {path}...")
+        importer = OlasServiceImporter()
+        discovered = importer.scan_directory(Path(path))
+
+        if not discovered:
+            console.print("[yellow]No Olas services found.[/yellow]")
+            raise typer.Exit(code=0)
+
+        # Display discovered services
+        console.print(f"\n[bold green]Found {len(discovered)} service(s):[/bold green]\n")
+        for i, service in enumerate(discovered, 1):
+            self._display_service_table(console, service, i)
+
+        if dry_run:
+            console.print("[yellow]Dry run mode - no changes made.[/yellow]")
+            raise typer.Exit(code=0)
+
+        # Confirm import
+        if not yes:
+            confirm = typer.confirm("Import these services?")
+            if not confirm:
+                console.print("[yellow]Aborted.[/yellow]")
+                raise typer.Exit(code=0)
+
+        # Check if we need a password for encrypted keys
+        needs_password = any(key.is_encrypted for service in discovered for key in service.keys)
+        if needs_password and not password:
+            console.print(
+                "\n[yellow]Some keys are encrypted. Please enter the source password.[/yellow]"
+            )
+            password = typer.prompt("Password", hide_input=True)
+
+        # Import services
+        total_keys, total_safes, total_services, all_skipped, all_errors = (
+            self._import_and_print_results(console, importer, discovered, password)
+        )
+
+        # Summary
+        console.print("\n[bold]Summary:[/bold]")
+        console.print(f"  Keys imported: {total_keys}")
+        console.print(f"  Safes imported: {total_safes}")
+        console.print(f"  Services imported: {total_services}")
+        if all_skipped:
+            console.print(f"  Skipped: {len(all_skipped)}")
+        if all_errors:
+            console.print(f"  [red]Errors: {len(all_errors)}[/red]")
+            raise typer.Exit(code=1)