hippius 0.2.4__py3-none-any.whl → 0.2.5__py3-none-any.whl

{hippius-0.2.4.dist-info → hippius-0.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hippius
-Version: 0.2.4
+Version: 0.2.5
 Summary: Python SDK and CLI for Hippius blockchain storage
 Home-page: https://github.com/thenervelab/hippius-sdk
 Author: Dubs

hippius-0.2.5.dist-info/RECORD

@@ -0,0 +1,17 @@
+hippius_sdk/__init__.py,sha256=LbBsuMIYPBStrXmKVlPxdE9qCwqFNaj9FTiHkWNZ1Zw,1391
+hippius_sdk/cli.py,sha256=_puHEeryJ5yDPgFJi0xcvMJl7Jlsa6-5K9EITOwSdQw,17821
+hippius_sdk/cli_assets.py,sha256=V3MX63QTiex6mCp0VDXQJ7cagm5v1s4xtsu8c1O4G_k,371
+hippius_sdk/cli_handlers.py,sha256=GmedWU9nGTA7DJKBnGnXQB7rhAfcl8ucbx5Hc05P_ZA,113964
+hippius_sdk/cli_parser.py,sha256=fU4kIeNM4an6FtyVX13-u33MmO70PrNzvmPe2ZtPf-0,19576
+hippius_sdk/cli_rich.py,sha256=_jTBYMdHi2--fIVwoeNi-EtkdOb6Zy_O2TUiGvU3O7s,7324
+hippius_sdk/client.py,sha256=eYURsq_so3WlEt_JY_u7J0iECFVOKDf5vsnGyR9Kngw,16974
+hippius_sdk/config.py,sha256=sCWD2remLa-FodvxC2O45tiNSJD7gzv9idIStX9sF_k,21240
+hippius_sdk/errors.py,sha256=LScJJmawVAx7aRzqqQguYSkf9iazSjEQEBNlD_GXZ6Y,1589
+hippius_sdk/ipfs.py,sha256=nO1EwxJCvmdEkNviWOKu0g0fv9qqCOkhKMmyzaHyf9g,71047
+hippius_sdk/ipfs_core.py,sha256=sZhwWF6gYoYANyf-NC5tFAzJVrmVTp9TnIsqcIFqI-E,15759
+hippius_sdk/substrate.py,sha256=HqR2-_9njZZ5UCKgiaGr5L5TGQ_wtj7oyA3sA5sGGyE,47525
+hippius_sdk/utils.py,sha256=Ur7P_7iVnXXYvbg7a0aVrdN_8NkVxjhdngn8NzR_zpc,7066
+hippius-0.2.5.dist-info/METADATA,sha256=w82vZdB717Z7lrlAp8tzeatZI0c30yWNP9ozcMRoXck,29992
+hippius-0.2.5.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+hippius-0.2.5.dist-info/entry_points.txt,sha256=b1lo60zRXmv1ud-c5BC-cJcAfGE5FD4qM_nia6XeQtM,98
+hippius-0.2.5.dist-info/RECORD,,

hippius_sdk/__init__.py

@@ -3,19 +3,30 @@ Hippius SDK - Python interface for Hippius blockchain storage
 """
 
 from hippius_sdk.client import HippiusClient
-from hippius_sdk.config import (decrypt_seed_phrase, delete_account,
-                                encrypt_seed_phrase, get_account_address,
-                                get_active_account, get_all_config,
-                                get_config_value, get_encryption_key,
-                                get_seed_phrase, initialize_from_env,
-                                list_accounts, load_config, reset_config,
-                                save_config, set_active_account,
-                                set_config_value, set_encryption_key,
-                                set_seed_phrase)
+from hippius_sdk.config import (
+    decrypt_seed_phrase,
+    delete_account,
+    encrypt_seed_phrase,
+    get_account_address,
+    get_active_account,
+    get_all_config,
+    get_config_value,
+    get_encryption_key,
+    get_seed_phrase,
+    initialize_from_env,
+    list_accounts,
+    load_config,
+    reset_config,
+    save_config,
+    set_active_account,
+    set_config_value,
+    set_encryption_key,
+    set_seed_phrase,
+)
 from hippius_sdk.ipfs import IPFSClient
 from hippius_sdk.utils import format_cid, format_size, hex_to_ipfs_cid
 
-__version__ = "0.2.4"
+__version__ = "0.2.5"
 __all__ = [
     "HippiusClient",
     "IPFSClient",

hippius_sdk/cli.py

@@ -113,6 +113,16 @@ def main():
         encrypt = True if args.encrypt else (False if args.no_encrypt else None)
         decrypt = True if args.decrypt else (False if args.no_decrypt else None)
 
+        # For erasure-code specifically, the password may have been requested and cached already
+        # We need to preserve it if it was set by handle_erasure_code
+        if (
+            args.command == "erasure-code"
+            and hasattr(client.substrate_client, "_seed_phrase")
+            and client.substrate_client._seed_phrase
+        ):
+            # Password has already been handled by the command handler
+            pass
+
         # Handle commands with the helper function
         if args.command == "download":
             return run_async_handler(
@@ -151,6 +161,7 @@ def main():
                 args.dir_path,
                 miner_ids,
                 encrypt=encrypt,
+                publish=not args.no_publish if hasattr(args, "no_publish") else True,
             )
 
         elif args.command == "credits":

hippius_sdk/cli_handlers.py

@@ -9,6 +9,7 @@ import asyncio
 import base64
 import getpass
 import json
+import math
 import os
 import tempfile
 import time
@@ -44,6 +45,12 @@ from hippius_sdk.cli_rich import (
     success,
     warning,
 )
+from hippius_sdk.errors import (
+    HippiusAlreadyDeletedError,
+    HippiusFailedIPFSUnpin,
+    HippiusFailedSubstrateDelete,
+    HippiusMetadataError,
+)
 
 try:
     import nacl.secret
@@ -147,6 +154,12 @@ async def handle_download(
         f"Size: [bold cyan]{result['size_bytes']:,}[/bold cyan] bytes ([bold cyan]{result['size_formatted']}[/bold cyan])",
     ]
 
+    # Add details about content type
+    if result.get("is_directory", False):
+        details.append("[bold green]Content type: Directory[/bold green]")
+    else:
+        details.append("[bold blue]Content type: File[/bold blue]")
+
     if result.get("decrypted"):
         details.append("[bold yellow]File was decrypted during download[/bold yellow]")
 
@@ -358,6 +371,7 @@ async def handle_store_dir(
     dir_path: str,
     miner_ids: Optional[List[str]] = None,
     encrypt: Optional[bool] = None,
+    publish: bool = True,
 ) -> int:
     """Handle the store directory command"""
     if not os.path.exists(dir_path):
@@ -417,12 +431,44 @@ async def handle_store_dir(
         updater = asyncio.create_task(update_progress())
 
         try:
+            # Upload info message based on publish flag
+            if not publish:
+                upload_info.append(
+                    "[bold yellow]Publishing: Disabled (local upload only)[/bold yellow]"
+                )
+                log(
+                    "\nUpload will be local only - not publishing to blockchain or pinning to IPFS"
+                )
+            else:
+                upload_info.append(
+                    "[bold green]Publishing: Enabled (publishing to blockchain)[/bold green]"
+                )
+
+            # Display updated upload information panel
+            print_panel("\n".join(upload_info), title="Directory Upload Operation")
+
             # Use the store_directory method
             result = await client.ipfs_client.upload_directory(
                 dir_path=dir_path,
                 encrypt=encrypt,
             )
 
+            # Skip publishing to blockchain if publish is False
+            if not publish:
+                # Remove any blockchain-related data from result to ensure we don't try to use it
+                if "transaction_hash" in result:
+                    del result["transaction_hash"]
+            else:
+                # If we want to publish, make sure files are pinned globally
+                for file_info in result.get("files", []):
+                    if "cid" in file_info:
+                        try:
+                            await client.ipfs_client.publish_global(file_info["cid"])
+                        except Exception as e:
+                            warning(
+                                f"Failed to publish file {file_info['name']} globally: {str(e)}"
+                            )
+
             # Complete the progress
             progress.update(task, completed=100)
             # Cancel the updater task
@@ -461,11 +507,15 @@ async def handle_store_dir(
                     ["Index", "Filename", "CID"],
                 )
 
-            # If we stored in the marketplace
-            if "transaction_hash" in result:
+            # If publishing is enabled and we stored in the marketplace
+            if publish and "transaction_hash" in result:
                 log(
                     f"\nStored in marketplace. Transaction hash: [bold]{result['transaction_hash']}[/bold]"
                 )
+            elif not publish:
+                log(
+                    "\n[yellow]Files were uploaded locally only. No blockchain publication or IPFS pinning.[/yellow]"
+                )
 
             return 0
 
@@ -991,6 +1041,36 @@ async def handle_erasure_code(
         )
         return 1
 
+    # Request password early if we're going to publish to the blockchain
+    if publish and client.substrate_client._seed_phrase is None:
+        # First check if we have an encrypted seed phrase that will require a password
+        config = load_config()
+        account_name = client.substrate_client._account_name or get_active_account()
+
+        if account_name and account_name in config["substrate"].get("accounts", {}):
+            account_data = config["substrate"]["accounts"][account_name]
+            is_encoded = account_data.get("seed_phrase_encoded", False)
+
+            if is_encoded:
+                warning("Wallet password will be required for publishing to blockchain")
+                password = getpass.getpass(
+                    "Enter password to decrypt seed phrase: \n\n"
+                )
+
+                # Store the password in client for later use
+                client.substrate_client._seed_phrase_password = password
+
+                # Pre-authenticate to ensure the password is correct
+                try:
+                    seed_phrase = decrypt_seed_phrase(password, account_name)
+                    if not seed_phrase:
+                        error("Failed to decrypt seed phrase. Incorrect password?")
+                        return 1
+                    client.substrate_client._seed_phrase = seed_phrase
+                except Exception as e:
+                    error(f"Error decrypting seed phrase: {e}")
+                    return 1
+
     # Get file size
     file_size = os.path.getsize(file_path)
     file_name = os.path.basename(file_path)
@@ -1020,11 +1100,18 @@ async def handle_erasure_code(
 
         chunk_size = new_chunk_size
 
+    # Calculate total number of chunks that will be created
+    total_original_chunks = max(1, int(math.ceil(file_size / chunk_size)))
+    total_encoded_chunks = total_original_chunks * m
+    estimated_size_per_chunk = min(chunk_size, file_size / total_original_chunks)
+
     # Create parameter information panel
     param_info = [
         f"File: [bold]{file_name}[/bold] ([bold cyan]{file_size / 1024 / 1024:.2f} MB[/bold cyan])",
         f"Parameters: k=[bold]{k}[/bold], m=[bold]{m}[/bold] (need {k} of {m} chunks to reconstruct)",
         f"Chunk size: [bold cyan]{chunk_size / 1024 / 1024:.6f} MB[/bold cyan]",
+        f"Total chunks to be created: [bold yellow]{total_encoded_chunks}[/bold yellow] ({total_original_chunks} original chunks × {m} encoded chunks each)",
+        f"Estimated storage required: [bold magenta]{(total_encoded_chunks * estimated_size_per_chunk) / (1024 * 1024):.2f} MB[/bold magenta]",
     ]
 
     # Add encryption status
@@ -1394,89 +1481,210 @@ async def handle_reconstruct(
 
 
 async def handle_delete(client: HippiusClient, cid: str, force: bool = False) -> int:
-    """Handle the delete command"""
-    info(f"Preparing to delete file with CID: [bold cyan]{cid}[/bold cyan]")
+    """Handle the delete command for files or directories"""
+    info(f"Preparing to delete content with CID: [bold cyan]{cid}[/bold cyan]")
+
+    # First check if this is a directory
+    try:
+        exists_result = await client.exists(cid)
+        if not exists_result["exists"]:
+            error(f"CID [bold cyan]{cid}[/bold cyan] not found on IPFS")
+            return 1
+    except Exception as e:
+        warning(f"Error checking if CID exists: {e}")
 
     if not force:
-        warning("This will cancel storage and remove the file from the marketplace.")
+        warning("This will cancel storage and remove the content from the marketplace.")
         confirm = input("Continue? (y/n): ").strip().lower()
         if confirm != "y":
             log("Deletion cancelled", style="yellow")
             return 0
 
-    info("Deleting file from marketplace...")
-    result = await client.delete_file(cid)
-
-    if result.get("success"):
-        success("File successfully deleted")
+    # Show spinner during deletion
+    with console.status("[cyan]Deleting content...[/cyan]", spinner="dots") as status:
+        result = await client.delete_file(cid)
 
-        details = []
-        if "transaction_hash" in result:
-            details.append(
-                f"Transaction hash: [bold]{result['transaction_hash']}[/bold]"
-            )
+    # Display results
+    is_directory = result.get("is_directory", False)
+    child_files = result.get("child_files", [])
 
-        # Create an informative panel with notes
-        notes = [
-            "1. The file is now unpinned from the marketplace",
-            "2. The CID may still resolve temporarily until garbage collection occurs",
-            "3. If the file was published to the global IPFS network, it may still be",
-            "   available through other nodes that pinned it",
+    if is_directory:
+        # Directory deletion
+        details = [
+            f"Successfully deleted directory: [bold cyan]{cid}[/bold cyan]",
+            f"Child files unpinned: [bold]{len(child_files)}[/bold]",
         ]
 
-        if details:
-            print_panel("\n".join(details), title="Transaction Details")
+        # If there are child files, show them in a table
+        if child_files:
+            table_data = []
+            for i, file in enumerate(
+                child_files[:10], 1
+            ):  # Limit to first 10 files if many
+                table_data.append(
+                    {
+                        "Index": str(i),
+                        "Filename": file.get("name", "unknown"),
+                        "CID": file.get("cid", "unknown"),
+                    }
+                )
 
-        print_panel("\n".join(notes), title="Important Notes")
+            if len(child_files) > 10:
+                table_data.append(
+                    {
+                        "Index": "...",
+                        "Filename": f"({len(child_files) - 10} more files)",
+                        "CID": "...",
+                    }
+                )
 
-        return 0
+            print_table(
+                "Unpinned Child Files", table_data, ["Index", "Filename", "CID"]
+            )
     else:
-        error(f"Failed to delete file: {result}")
+        # Regular file deletion
+        details = [f"Successfully deleted file: [bold cyan]{cid}[/bold cyan]"]
+
+    if "duration_seconds" in result.get("timing", {}):
+        details.append(
+            f"Deletion completed in [bold green]{result['timing']['duration_seconds']:.2f}[/bold green] seconds"
+        )
+
+    print_panel("\n".join(details), title="Deletion Complete")
+
+    # Create an informative panel with notes
+    notes = [
+        "1. The content is now unpinned from the marketplace",
+        "2. The CID may still resolve temporarily until garbage collection occurs",
+        "3. If the content was published to the global IPFS network, it may still be",
+        "   available through other nodes that pinned it",
+    ]
+
+    print_panel("\n".join(notes), title="Important Notes")
+
+    return 0
 
 
 async def handle_ec_delete(
     client: HippiusClient, metadata_cid: str, force: bool = False
 ) -> int:
-    """Handle the ec-delete command"""
-    info(
-        f"Preparing to delete erasure-coded file with metadata CID: [bold cyan]{metadata_cid}[/bold cyan]"
-    )
+    """Handle the erasure-code delete command"""
 
+    # Create a stylish header with the CID
+    info(f"Preparing to delete erasure-coded file with metadata CID:")
+    print_panel(f"[bold cyan]{metadata_cid}[/bold cyan]", title="Metadata CID")
+
+    # Confirm the deletion if not forced
     if not force:
-        warning("This will delete the metadata and all chunks from the marketplace.")
-        confirm = input("Continue? (y/n): ").strip().lower()
+        warning_text = [
+            "This will cancel the storage of this file on the Hippius blockchain.",
+            "The file metadata will be removed from blockchain storage tracking.",
+            "[dim]Note: Only the metadata CID will be canceled; contents may remain on IPFS.[/dim]",
+        ]
+        print_panel("\n".join(warning_text), title="Warning")
+
+        confirm = input("Continue with deletion? (y/n): ").strip().lower()
         if confirm != "y":
             log("Deletion cancelled", style="yellow")
             return 0
 
     try:
+        # First, pre-authenticate the client to get any password prompts out of the way
+        # This accesses the substrate client to trigger authentication
+        if not client.substrate_client._keypair:
+            client.substrate_client._ensure_keypair()
+
+        # Now we can show the spinner after any password prompts
         info("Deleting erasure-coded file from marketplace...")
-        result = await client.delete_ec_file(metadata_cid)
 
-        if result.get("success"):
-            success("Erasure-coded file successfully deleted")
+        # Create a more detailed spinner with phases
+        with console.status(
+            "[cyan]Processing file metadata and chunks...[/cyan]", spinner="dots"
+        ) as status:
+            try:
+                # Use the specialized delete method that now throws specific exceptions
+                await client.delete_ec_file(metadata_cid)
 
-            # Show detailed results
-            details = []
-            chunks_deleted = result.get("chunks_deleted", 0)
-            details.append(f"Deleted [bold]{chunks_deleted}[/bold] chunks")
+                # If we get here, deletion was successful
+                deletion_success = True
+                already_deleted = False
 
-            if "transaction_hash" in result:
-                details.append(
-                    f"Transaction hash: [bold]{result['transaction_hash']}[/bold]"
+            except HippiusAlreadyDeletedError:
+                # Special case - already deleted
+                deletion_success = False
+                already_deleted = True
+
+            except HippiusFailedSubstrateDelete as e:
+                # Blockchain deletion failed
+                error(f"Blockchain storage cancellation failed: {e}")
+                return 1
+
+            except HippiusFailedIPFSUnpin as e:
+                # IPFS unpinning failed, but blockchain deletion succeeded
+                warning(
+                    f"Note: Some IPFS operations failed, but blockchain storage was successfully canceled"
+                )
+                # Consider this a success for the user since the more important blockchain part worked
+                deletion_success = True
+                already_deleted = False
+
+            except HippiusMetadataError as e:
+                # Metadata parsing failed, but we can still continue
+                warning(
+                    f"Note: Metadata file was corrupted, but blockchain storage was successfully canceled"
                 )
+                # Consider this a success for the user since the blockchain part worked
+                deletion_success = True
+                already_deleted = False
 
-            print_panel("\n".join(details), title="Deletion Results")
+            except Exception as e:
+                # Handle any unexpected errors
+                error(f"Unexpected error: {e}")
+                return 1
 
+        # Show the result
+        if deletion_success:
+            # Create a success panel
+            success_panel = [
+                "[bold green]✓[/bold green] Metadata CID canceled from blockchain storage",
+                f"[dim]This file is no longer tracked for storage payments[/dim]",
+                "",
+                "[dim]To purge file data completely:[/dim]",
+                "• Individual chunks may still exist on IPFS and nodes",
+                "• For complete deletion, all chunks should be unpinned manually",
+            ]
+            print_panel(
+                "\n".join(success_panel), title="Storage Cancellation Successful"
+            )
+            return 0
+        elif already_deleted:
+            # Create a panel for the already deleted case
+            already_panel = [
+                "[bold yellow]![/bold yellow] This file has already been deleted from storage",
+                "[dim]The CID was not found in the blockchain storage registry[/dim]",
+                "",
+                "This is expected if:",
+                "• You previously deleted this file",
+                "• The file was deleted by another process",
+                "• The file was never stored in the first place",
+            ]
+            print_panel("\n".join(already_panel), title="Already Deleted")
+            # Return 0 since this is not an error condition
             return 0
         else:
-            error(
-                f"Failed to delete erasure-coded file: {result.get('message', 'Unknown error')}"
-            )
+            # Create an error panel for all other failures
+            error_panel = [
+                "[bold red]×[/bold red] File not found in blockchain storage",
+                "[dim]The metadata CID was not found in the blockchain storage registry[/dim]",
+                "",
+                "Possible reasons:",
+                "• The CID may be incorrect",
+                "• You may not be the owner of this file",
+            ]
+            print_panel("\n".join(error_panel), title="Storage Cancellation Failed")
             return 1
-
     except Exception as e:
-        error(f"Failed to delete erasure-coded file: {e}")
+        error(f"Error deleting erasure-coded file: {e}")
         return 1
 
 

hippius_sdk/cli_parser.py

@@ -197,12 +197,32 @@ def add_storage_commands(subparsers):
         "store", help="Upload a file to IPFS and store it on Substrate"
     )
     store_parser.add_argument("file_path", help="Path to file to upload")
+    store_parser.add_argument(
+        "--publish",
+        action="store_true",
+        help="Publish file to IPFS and store on the blockchain (default)",
+    )
+    store_parser.add_argument(
+        "--no-publish",
+        action="store_true",
+        help="Don't publish file to IPFS or store on the blockchain (local only)",
+    )
 
     # Store directory command
     store_dir_parser = subparsers.add_parser(
         "store-dir", help="Upload a directory to IPFS and store all files on Substrate"
     )
     store_dir_parser.add_argument("dir_path", help="Path to directory to upload")
+    store_dir_parser.add_argument(
+        "--publish",
+        action="store_true",
+        help="Publish all files to IPFS and store on the blockchain (default)",
+    )
+    store_dir_parser.add_argument(
+        "--no-publish",
+        action="store_true",
+        help="Don't publish files to IPFS or store on the blockchain (local only)",
+    )
 
     # Pinning status command
     pinning_status_parser = subparsers.add_parser(

hippius_sdk/cli_rich.py

@@ -6,8 +6,14 @@ from typing import Any, Dict, List, Optional, Union
 
 from rich.console import Console
 from rich.panel import Panel
-from rich.progress import (BarColumn, Progress, SpinnerColumn, TextColumn,
-                           TimeElapsedColumn, TimeRemainingColumn)
+from rich.progress import (
+    BarColumn,
+    Progress,
+    SpinnerColumn,
+    TextColumn,
+    TimeElapsedColumn,
+    TimeRemainingColumn,
+)
 from rich.table import Table
 from rich.text import Text
 

hippius_sdk/client.py

@@ -148,10 +148,11 @@ class HippiusClient:
     ) -> Dict[str, Any]:
         """
         Download a file from IPFS with optional decryption.
+        Supports downloading directories - in that case, a directory structure will be created.
 
         Args:
             cid: Content Identifier (CID) of the file to download
-            output_path: Path where the downloaded file will be saved
+            output_path: Path where the downloaded file/directory will be saved
             decrypt: Whether to decrypt the file (overrides default)
 
         Returns:
@@ -162,6 +163,7 @@ class HippiusClient:
                 - size_formatted: Human-readable file size
                 - elapsed_seconds: Time taken for the download
                 - decrypted: Whether the file was decrypted
+                - is_directory: Whether the download was a directory
 
         Raises:
             requests.RequestException: If the download fails
@@ -436,7 +438,7 @@ class HippiusClient:
         metadata_cid: str,
         cancel_from_blockchain: bool = True,
         parallel_limit: int = 20,
-    ) -> Dict[str, Any]:
+    ) -> bool:
         """
         Delete an erasure-coded file, including all its chunks in parallel.
 
@@ -446,7 +448,7 @@ class HippiusClient:
             parallel_limit: Maximum number of concurrent deletion operations
 
         Returns:
-            Dict containing the result of the operation
+            True or false if failed.
 
         Raises:
             RuntimeError: If deletion fails completely