hippius 0.2.37__py3-none-any.whl → 0.2.38__py3-none-any.whl

{hippius-0.2.37.dist-info → hippius-0.2.38.dist-info}/METADATA

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

{hippius-0.2.37.dist-info → hippius-0.2.38.dist-info}/RECORD

@@ -1,10 +1,10 @@
-hippius_sdk/__init__.py,sha256=FuqP1SPjpm3IjJbpPQtXE-1Q5HGju9bK-0TwDTy2uJY,1474
+hippius_sdk/__init__.py,sha256=gn9TSRkyahOIqzJMx6svFcXNOC2etuj_uFCleBzcLIw,1508
 hippius_sdk/cli.py,sha256=aqKOYSBSWt7UhcpFt7wf9yIPJ3bznpsJ6ehOnuZ4usI,18235
 hippius_sdk/cli_assets.py,sha256=rjH3Z5A1CQr2d5CIAAAb0WMCjoZZlMWcdo0f93KqluE,635
 hippius_sdk/cli_handlers.py,sha256=HkZldE8ZDS6WHu8aSoeS_rYZ4kp3F-Kdzu-weY1c0vU,128258
 hippius_sdk/cli_parser.py,sha256=z7UvgWvvy04ey-R56qZiCqYc_9RaNq1rVDkQyXoK3JU,21100
 hippius_sdk/cli_rich.py,sha256=_jTBYMdHi2--fIVwoeNi-EtkdOb6Zy_O2TUiGvU3O7s,7324
-hippius_sdk/client.py,sha256=aGnNdXMLUurqIvKZBbbASNg4yPXw_smfof9CQWPsr-4,22958
+hippius_sdk/client.py,sha256=yS7fKAYIIjLReoUg1hppCD1sRy5MbSS81aLF_JLIZRE,23275
 hippius_sdk/config.py,sha256=Hf_aUYzG9ylzqauA_ABUSSB5mBTYbp-VtB36VQt2XDw,21981
 hippius_sdk/db/README.md,sha256=okDeI1qgkaZqXSlJ8L0xIE4UpuxO-qEGPIbXUvSHQjU,2030
 hippius_sdk/db/env.db.template,sha256=_6hEC3IvkzCDOAzG1_yJUKRUfCTMciNaJUicZpMCat4,217
@@ -13,12 +13,12 @@ hippius_sdk/db/migrations/20241202000001_switch_to_subaccount_encryption.sql,sha
 hippius_sdk/db/setup_database.sh,sha256=STp03qxkp2RmIVr6YZIcvQQm-_LLUOb6Jobh-52HWmg,3115
 hippius_sdk/db_utils.py,sha256=-x0rbN0as7Tn3PJPZBYCgreZe52FLH40ppA1TLxsg90,1851
 hippius_sdk/errors.py,sha256=LScJJmawVAx7aRzqqQguYSkf9iazSjEQEBNlD_GXZ6Y,1589
-hippius_sdk/ipfs.py,sha256=Gyow5xogdjV3W8uQzAxbvROw3tL3WZU-Zz7TtQdyHWs,96337
+hippius_sdk/ipfs.py,sha256=bctkg_QW4rclZLDhXgNrM6dj0z-ae2--IWaUTHmdCl8,97356
 hippius_sdk/ipfs_core.py,sha256=X4yO9M_lSNtqiEJu5R-XX97eWzbL7GrN5MOk56p8pJk,12748
 hippius_sdk/key_storage.py,sha256=SXFd6aGQw9MDLGX2vSBuAY7rdX-k5EvFm63z7_n-8yQ,8148
 hippius_sdk/substrate.py,sha256=4a7UIE4UqGcDW7luKTBgSDqfb2OIZusB39G1UiRs_YU,50158
 hippius_sdk/utils.py,sha256=rJ611yvwKSyiBpYU3w-SuyQxoghMGU-ePuslrPv5H5g,7388
-hippius-0.2.37.dist-info/METADATA,sha256=abEkJKwKRWH1cq_mF1Yd_HoGggvKPqE19Y9HDWn9GBs,30088
-hippius-0.2.37.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-hippius-0.2.37.dist-info/entry_points.txt,sha256=bFAZjW3vndretf9-8s587jA2ebMVI7puhn_lVs8jPc8,149
-hippius-0.2.37.dist-info/RECORD,,
+hippius-0.2.38.dist-info/METADATA,sha256=50XF9hBgZ_Cu0jPesNPTDqhSoJb4YPNFKIOG-wFjwD8,30088
+hippius-0.2.38.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+hippius-0.2.38.dist-info/entry_points.txt,sha256=bFAZjW3vndretf9-8s587jA2ebMVI7puhn_lVs8jPc8,149
+hippius-0.2.38.dist-info/RECORD,,

hippius_sdk/__init__.py

@@ -23,14 +23,15 @@ from hippius_sdk.config import (
     set_encryption_key,
     set_seed_phrase,
 )
-from hippius_sdk.ipfs import IPFSClient, S3PublishResult, S3DownloadResult
+from hippius_sdk.ipfs import IPFSClient, S3PublishResult, S3PublishPin, S3DownloadResult
 from hippius_sdk.utils import format_cid, format_size, hex_to_ipfs_cid
 
-__version__ = "0.2.37"
+__version__ = "0.2.38"
 __all__ = [
     "HippiusClient",
     "IPFSClient",
     "S3PublishResult",
+    "S3PublishPin",
     "S3DownloadResult",
     "get_config_value",
     "set_config_value",

hippius_sdk/client.py

@@ -3,13 +3,13 @@ Main client for the Hippius SDK.
 """
 
 import base64
-from typing import Any, Callable, Dict, List, Optional
+from typing import Any, Callable, Dict, List, Optional, Union
 
 import nacl.secret
 import nacl.utils
 
 from hippius_sdk.config import get_config_value, get_encryption_key
-from hippius_sdk.ipfs import IPFSClient, S3PublishResult, S3DownloadResult
+from hippius_sdk.ipfs import IPFSClient, S3PublishResult, S3PublishPin, S3DownloadResult
 from hippius_sdk.substrate import SubstrateClient
 
 
@@ -525,7 +525,8 @@ class HippiusClient:
         store_node: str = "http://localhost:5001",
         pin_node: str = "https://store.hippius.network",
         substrate_url: str = "wss://rpc.hippius.network",
-    ) -> S3PublishResult:
+        publish: bool = True,
+    ) -> Union[S3PublishResult, S3PublishPin]:
         """
         Publish a file to IPFS and the Hippius marketplace in one operation.
 
@@ -541,10 +542,12 @@ class HippiusClient:
             bucket_name: The bucket name for key isolation
             store_node: IPFS node URL for initial upload (default: local node)
             pin_node: IPFS node URL for backup pinning (default: remote service)
-            substrate_url: substrate url to use for the storage request.
+            substrate_url: substrate url to use for the storage request
+            publish: Whether to publish to blockchain (True) or just upload to IPFS (False)
 
         Returns:
-            S3PublishResult: Object containing CID, file info, and transaction hash
+            S3PublishResult: Object containing CID, file info, and transaction hash when publish=True
+            S3PublishPin: Object containing CID, subaccount, file_path, pin_node, substrate_url when publish=False
 
         Raises:
             HippiusIPFSError: If IPFS operations (add or pin) fail
@@ -561,6 +564,7 @@ class HippiusClient:
             store_node,
             pin_node,
             substrate_url,
+            publish,
         )
 
     async def s3_download(

hippius_sdk/ipfs.py

@@ -12,7 +12,7 @@ import shutil
 import tempfile
 import time
 import uuid
-from typing import Any, Callable, Dict, List, Optional
+from typing import Any, Callable, Dict, List, Optional, Union
 
 import httpx
 from pydantic import BaseModel
@@ -62,6 +62,16 @@ class S3PublishResult(BaseModel):
     tx_hash: str
 
 
+class S3PublishPin(BaseModel):
+    """Result model for s3_publish method when publish=False."""
+
+    cid: str
+    subaccount: str
+    file_path: str
+    pin_node: str
+    substrate_url: str
+
+
 class S3DownloadResult(BaseModel):
     """Result model for s3_download method."""
 
@@ -1958,7 +1968,8 @@ class IPFSClient:
         store_node: str = "http://localhost:5001",
         pin_node: str = "https://store.hippius.network",
         substrate_url: str = "wss://rpc.hippius.network",
-    ) -> S3PublishResult:
+        publish: bool = True,
+    ) -> Union[S3PublishResult, S3PublishPin]:
         """
         Publish a file to IPFS and the Hippius marketplace in one operation.
 
@@ -1980,10 +1991,12 @@ class IPFSClient:
             bucket_name: The bucket name for key isolation
             store_node: IPFS node URL for initial upload (default: local node)
             pin_node: IPFS node URL for backup pinning (default: remote service)
-            substrate_url: the substrate url to connect to for the storage request.
+            substrate_url: the substrate url to connect to for the storage request
+            publish: Whether to publish to blockchain (True) or just upload to IPFS (False)
 
         Returns:
-            S3PublishResult: Object containing CID, file info, and transaction hash
+            S3PublishResult: Object containing CID, file info, and transaction hash when publish=True
+            S3PublishPin: Object containing CID, subaccount, file_path, pin_node, substrate_url when publish=False
 
         Raises:
             HippiusIPFSError: If IPFS operations (add or pin) fail
@@ -2094,54 +2107,64 @@ class IPFSClient:
                 f"Failed to pin file to store node {store_node}: {str(e)}"
             )
 
-        # Publish to substrate marketplace
-        try:
-            # Pass the seed phrase directly to avoid password prompts for encrypted config
-            substrate_client = SubstrateClient(
-                seed_phrase=seed_phrase, url=substrate_url
-            )
-            logger.info(
-                f"Submitting storage request to substrate for file: {filename}, CID: {cid}"
-            )
+        # Conditionally publish to substrate marketplace based on publish flag
+        if publish:
+            try:
+                # Pass the seed phrase directly to avoid password prompts for encrypted config
+                substrate_client = SubstrateClient(
+                    seed_phrase=seed_phrase, url=substrate_url
+                )
+                logger.info(
+                    f"Submitting storage request to substrate for file: {filename}, CID: {cid}"
+                )
 
-            tx_hash = await substrate_client.storage_request(
-                files=[
-                    FileInput(
-                        file_hash=cid,
-                        file_name=filename,
-                    )
-                ],
-                miner_ids=[],
-                seed_phrase=seed_phrase,
-            )
+                tx_hash = await substrate_client.storage_request(
+                    files=[
+                        FileInput(
+                            file_hash=cid,
+                            file_name=filename,
+                        )
+                    ],
+                    miner_ids=[],
+                    seed_phrase=seed_phrase,
+                )
+
+                logger.debug(f"Substrate call result: {tx_hash}")
 
-            logger.debug(f"Substrate call result: {tx_hash}")
+                # Check if we got a valid transaction hash
+                if not tx_hash or tx_hash == "0x" or len(tx_hash) < 10:
+                    logger.error(f"Invalid transaction hash received: {tx_hash}")
+                    raise HippiusSubstrateError(
+                        f"Invalid transaction hash received: {tx_hash}. This might indicate insufficient credits or transaction failure."
+                    )
 
-            # Check if we got a valid transaction hash
-            if not tx_hash or tx_hash == "0x" or len(tx_hash) < 10:
-                logger.error(f"Invalid transaction hash received: {tx_hash}")
-                raise HippiusSubstrateError(
-                    f"Invalid transaction hash received: {tx_hash}. This might indicate insufficient credits or transaction failure."
+                logger.info(
+                    f"Successfully published to substrate with transaction: {tx_hash}"
                 )
 
-            logger.info(
-                f"Successfully published to substrate with transaction: {tx_hash}"
+            except Exception as e:
+                logger.error(f"Substrate call failed: {str(e)}")
+                logger.debug(
+                    "Possible causes: insufficient credits, network issues, invalid seed phrase, or substrate node unavailability"
+                )
+                raise HippiusSubstrateError(f"Failed to publish to substrate: {str(e)}")
+
+            return S3PublishResult(
+                cid=cid,
+                file_name=filename,
+                size_bytes=size_bytes,
+                encryption_key=encryption_key_used,
+                tx_hash=tx_hash,
             )
-
-        except Exception as e:
-            logger.error(f"Substrate call failed: {str(e)}")
-            logger.debug(
-                "Possible causes: insufficient credits, network issues, invalid seed phrase, or substrate node unavailability"
+        else:
+            # Return S3PublishPin with required information when not publishing
+            return S3PublishPin(
+                cid=cid,
+                subaccount=subaccount_id,
+                file_path=file_path,
+                pin_node=pin_node,
+                substrate_url=substrate_url,
             )
-            raise HippiusSubstrateError(f"Failed to publish to substrate: {str(e)}")
-
-        return S3PublishResult(
-            cid=cid,
-            file_name=filename,
-            size_bytes=size_bytes,
-            encryption_key=encryption_key_used,
-            tx_hash=tx_hash,
-        )
 
     async def s3_download(
         self,