hippius 0.1.13__py3-none-any.whl → 0.2.0__py3-none-any.whl

hippius_sdk/utils.py

@@ -0,0 +1,152 @@
+"""
+Utility functions for the Hippius SDK.
+
+This module provides common utility functions used across the SDK.
+"""
+
+import binascii
+from typing import Optional
+
+
+def format_size(size_bytes: int) -> str:
+    """
+    Format a size in bytes to a human-readable string.
+
+    Args:
+        size_bytes: Size in bytes
+
+    Returns:
+        str: Human-readable size string (e.g., '1.23 MB', '456.78 KB')
+    """
+    if size_bytes >= 1024 * 1024 * 1024:
+        return f"{size_bytes / (1024 * 1024 * 1024):.2f} GB"
+    elif size_bytes >= 1024 * 1024:
+        return f"{size_bytes / (1024 * 1024):.2f} MB"
+    elif size_bytes >= 1024:
+        return f"{size_bytes / 1024:.2f} KB"
+    else:
+        return f"{size_bytes} bytes"
+
+
+def is_valid_cid(cid: str) -> bool:
+    """
+    Check if a string is likely a valid IPFS CID.
+
+    Args:
+        cid: String to check
+
+    Returns:
+        bool: True if it appears to be a valid CID
+    """
+    return (
+        cid
+        and isinstance(cid, str)
+        and cid.startswith(("Qm", "bafy", "bafk", "bafyb", "bafzb", "b"))
+    )
+
+
+def normalize_hex_string(hex_string: str) -> str:
+    """
+    Normalize a hex string by removing '0x' prefix if present.
+
+    Args:
+        hex_string: Hex string to normalize
+
+    Returns:
+        str: Normalized hex string without '0x' prefix
+    """
+    if isinstance(hex_string, str) and hex_string.startswith("0x"):
+        return hex_string[2:]
+    return hex_string
+
+
+def is_valid_hex(hex_string: str) -> bool:
+    """
+    Check if a string contains only valid hexadecimal characters.
+
+    Args:
+        hex_string: String to check
+
+    Returns:
+        bool: True if the string contains only valid hex characters
+    """
+    return all(c in "0123456789abcdefABCDEF" for c in hex_string)
+
+
+def hex_to_ipfs_cid(hex_string: str) -> str:
+    """
+    Convert a hex-encoded IPFS CID to a regular IPFS CID.
+
+    This function handles multiple formats:
+    1. Proper CIDs directly (starting with Qm, bafy, etc.)
+    2. Hex strings that, when decoded, represent ASCII CIDs
+    3. Binary CIDv0 hex representations
+    4. Other hex formats
+
+    Args:
+        hex_string: Hex string representation of an IPFS CID
+
+    Returns:
+        str: Regular IPFS CID
+    """
+    # If it's already a proper CID, return it directly
+    if is_valid_cid(hex_string):
+        return hex_string
+
+    # Normalize by removing 0x prefix if present
+    norm_hex = normalize_hex_string(hex_string)
+
+    # If not valid hex after normalization, it might be a direct CID
+    if not is_valid_hex(norm_hex):
+        if is_valid_cid(norm_hex):
+            return norm_hex
+        # Return original if we can't process it
+        return hex_string
+
+    # First, try to decode as ASCII if it's a hex representation of ASCII characters
+    try:
+        bytes_data = bytes.fromhex(norm_hex)
+        ascii_str = bytes_data.decode("ascii")
+
+        # If the decoded string starts with a valid CID prefix, return it
+        if is_valid_cid(ascii_str):
+            return ascii_str
+    except Exception:
+        # If ASCII decoding fails, continue with other methods
+        pass
+
+    # Try to decode as a binary CID
+    try:
+        import base58
+
+        binary_data = bytes.fromhex(norm_hex)
+
+        # Check if it matches CIDv0 pattern (starts with 0x12, 0x20)
+        if len(binary_data) > 2 and binary_data[0] == 0x12 and binary_data[1] == 0x20:
+            # CIDv0 (Qm...)
+            return base58.b58encode(binary_data).decode("utf-8")
+
+        # If it doesn't match CIDv0, for CIDv1 just return the hex without 0x prefix
+        return norm_hex
+    except ImportError:
+        # If base58 is not available
+        print("Warning: base58 module not available for proper CID conversion")
+        return norm_hex
+    except Exception as e:
+        print(f"Error converting hex to CID: {e}")
+        return hex_string
+
+
+def format_cid(cid: str) -> str:
+    """
+    Format a CID for display.
+
+    This is a wrapper around hex_to_ipfs_cid for backward compatibility.
+
+    Args:
+        cid: Content Identifier (CID) to format
+
+    Returns:
+        str: Formatted CID string
+    """
+    return hex_to_ipfs_cid(cid)

hippius-0.1.13.dist-info/RECORD

@@ -1,10 +0,0 @@
-hippius_sdk/__init__.py,sha256=pEVObrzsEpX0iJhtAEmzY832jVEr7wVPqoxaSwsE3BM,1261
-hippius_sdk/cli.py,sha256=thTRIjKNoCiKaxH1P2UukVvH8r3zR6PDaYEk9ROHiAA,74073
-hippius_sdk/client.py,sha256=dIrjaXl2J71_ljhu_nFS-gTOmKDRPzJDXeviBSOAeis,14894
-hippius_sdk/config.py,sha256=nLDmZft5hR_mD_NrmnnfMwfWRCsp2uQi2f1mTWu-fC4,22870
-hippius_sdk/ipfs.py,sha256=kMqmtyvdjzo1JlXTdLYA74zAmZocDAOsW9cmzwG6ejg,63959
-hippius_sdk/substrate.py,sha256=hyPCjLCTuBTWqHvU8eMowpThsIJYUrvX4yepIs3NcZk,33037
-hippius-0.1.13.dist-info/METADATA,sha256=Brw4f-3IFqK85YePwvAWWEbKmgxd3RcOOrGpsJcE8I4,28001
-hippius-0.1.13.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-hippius-0.1.13.dist-info/entry_points.txt,sha256=b1lo60zRXmv1ud-c5BC-cJcAfGE5FD4qM_nia6XeQtM,98
-hippius-0.1.13.dist-info/RECORD,,