hippius 0.1.7__tar.gz → 0.1.10__tar.gz

{hippius-0.1.7 → hippius-0.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hippius
-Version: 0.1.7
+Version: 0.1.10
 Summary: Python SDK and CLI for Hippius blockchain storage
 Home-page: https://github.com/thenervelab/hippius-sdk
 Author: Dubs
@@ -67,7 +67,7 @@ client = HippiusClient()
 # Or specify custom endpoints
 client = HippiusClient(
     ipfs_gateway="https://ipfs.io",                       # For downloads (default)
-    ipfs_api_url="https://relay-fr.hippius.network",  # For uploads (default)
+    ipfs_api_url="https://store.hippius.network",  # For uploads (default)
 )
 
 # Upload a file to IPFS
@@ -313,6 +313,64 @@ This command provides detailed information about each erasure-coded file includi
 - Miners storing the file
 - Reconstruction command
 
+The `ec-files` command is optimized for performance through parallel processing and intelligent filtering, making it efficient even with large numbers of files.
+
+#### Performance Considerations
+
+The erasure coding implementation has been optimized for:
+
+1. **Speed**: Parallel processing for file operations
+2. **Memory efficiency**: Files are processed in chunks to minimize memory usage
+3. **Auto-tuning**: Parameters like chunk size are automatically adjusted for small files
+4. **Intelligent filtering**: The system can quickly identify potential erasure-coded files
+
+For extremely large files (>1GB), consider using larger chunk sizes to improve performance:
+
+```bash
+hippius erasure-code large_video.mp4 --chunk-size 10485760  # 10MB chunks
+```
+
+#### Directory Support for Erasure Coding
+
+Hippius SDK now supports applying erasure coding to entire directories:
+
+```bash
+# Apply erasure coding to an entire directory
+hippius erasure-code my_directory/
+
+# The CLI will detect that it's a directory and offer two options:
+# 1. Archive the directory first, then erasure code the archive
+# 2. Apply erasure coding to each file in the directory individually
+```
+
+When choosing the second option, the system will process each file in the directory individually, adjusting parameters like chunk size automatically for small files. A summary of the operation will be displayed, showing:
+- Total files processed
+- Successfully coded files with their metadata CIDs
+- Any files that failed, with error details
+
+To reconstruct a file from erasure-coded chunks:
+
+```bash
+hippius reconstruct QmMetadataCID reconstructed_filename
+```
+
+#### Default Address Management
+
+Hippius SDK now allows setting a default address for read-only operations, making it easier to use commands like `files` and `ec-files` without specifying an account address each time:
+
+```bash
+# Set a default address for read-only operations
+hippius address set-default 5H1QBRF7T7dgKwzVGCgS4wioudvMRf9K4NEDzfuKLnuyBNzH
+
+# View the currently set default address
+hippius address get-default
+
+# Clear the default address
+hippius address clear-default
+```
+
+Once a default address is set, commands like `hippius files` and `hippius ec-files` will automatically use this address when no explicit address is provided.
+
 #### Troubleshooting
 
 1. **IPFS Connection Issues**: Make sure you have either:
@@ -333,7 +391,30 @@ This command provides detailed information about each erasure-coded file includi
    which hippius
    ```
 
-4. **Substrate Issues**: For marketplace operations, make sure your `.env` has the correct `SUBSTRATE_SEED_PHRASE` and `SUBSTRATE_URL` values.
+4. **Default Address Issues**: If you receive errors about missing account address:
+   ```bash
+   # Set a default address for read-only operations
+   hippius address set-default 5H1QBRF7T7dgKwzVGCgS4wioudvMRf9K4NEDzfuKLnuyBNzH
+   ```
+
+5. **Substrate Issues**: For marketplace operations, make sure your `.env` has the correct `SUBSTRATE_SEED_PHRASE` and `SUBSTRATE_URL` values.
+
+6. **Erasure Coding Problems**:
+   - **"Wrong length for input blocks"**: This typically happens with very small files
+     ```bash
+     # Try smaller k and m values for small files
+     hippius erasure-code small_file.txt --k 2 --m 3
+     ```
+   - **Directories can't be directly coded**: Use the directory support option when prompted
+   - **"zfec is required"**: Install the missing package
+     ```bash
+     pip install zfec
+     poetry add zfec
+     ```
+   - **Slow performance with large files**: Increase chunk size
+     ```bash
+     hippius erasure-code large_file.mp4 --chunk-size 5242880  # 5MB chunks
+     ```
 
 ## Command Line Interface
 
@@ -346,7 +427,7 @@ The Hippius SDK includes a powerful command-line interface (CLI) that provides a
 hippius --help
 
 # Set global options
-hippius --gateway https://ipfs.io --api-url https://relay-fr.hippius.network --verbose
+hippius --gateway https://ipfs.io --api-url https://store.hippius.network --verbose
 ```
 
 ### IPFS Operations
@@ -431,7 +512,7 @@ hippius ec-files --all-miners
 hippius ec-files --show-chunks
 ```
 
-The `ec-files` command makes it easy to track and manage your erasure-coded files separately from regular files. It provides the metadata CID needed for reconstruction and information about chunk distribution.
+The `ec-files` command has been optimized for performance and can now handle large numbers of files efficiently through parallel processing.
 
 ### Using Environment Variables
 
@@ -439,7 +520,7 @@ The CLI automatically reads from your `.env` file for common settings:
 
 ```
 IPFS_GATEWAY=https://ipfs.io
-IPFS_API_URL=https://relay-fr.hippius.network
+IPFS_API_URL=https://store.hippius.network
 SUBSTRATE_URL=wss://rpc.hippius.network
 SUBSTRATE_SEED_PHRASE="your twelve word seed phrase..."
 SUBSTRATE_DEFAULT_MINERS=miner1,miner2,miner3
@@ -546,13 +627,14 @@ The configuration is organized in the following sections:
 {
   "ipfs": {
     "gateway": "https://ipfs.io",
-    "api_url": "https://relay-fr.hippius.network",
+    "api_url": "https://store.hippius.network",
     "local_ipfs": false
   },
   "substrate": {
     "url": "wss://rpc.hippius.network",
     "seed_phrase": null,
-    "default_miners": []
+    "default_miners": [],
+    "default_address": null
   },
   "encryption": {
     "encrypt_by_default": false,
@@ -737,7 +819,13 @@ hippius --help
    which hippius
    ```
 
-4. **Substrate Issues**: For marketplace operations, make sure your `.env` has the correct `SUBSTRATE_SEED_PHRASE` and `SUBSTRATE_URL` values.
+4. **Default Address Issues**: If you receive errors about missing account address:
+   ```bash
+   # Set a default address for read-only operations
+   hippius address set-default 5H1QBRF7T7dgKwzVGCgS4wioudvMRf9K4NEDzfuKLnuyBNzH
+   ```
+
+5. **Substrate Issues**: For marketplace operations, make sure your `.env` has the correct `SUBSTRATE_SEED_PHRASE` and `SUBSTRATE_URL` values.
 
 ## Contributing
 
@@ -855,3 +943,95 @@ client = HippiusClient(
 
 The multi-account system makes it easier to manage multiple identities while maintaining security and convenience.
 
+## Blockchain Account Management
+
+Hippius SDK provides a comprehensive solution for managing blockchain accounts, including coldkeys, hotkeys, and proxy relationships.
+
+### Coldkeys and Hotkeys
+
+Hippius uses a hierarchical account structure:
+
+- **Coldkey**: The main account that holds your funds and grants permissions
+- **Hotkey**: Delegated accounts that can perform specific actions on behalf of your coldkey
+
+This separation provides enhanced security by allowing you to keep your main account (coldkey) secure while using hotkeys for day-to-day operations.
+
+### Creating and Managing Accounts
+
+```python
+from hippius_sdk.account import AccountManager
+
+# Initialize the account manager
+account_manager = AccountManager()
+
+# Create a coldkey (main account)
+coldkey = account_manager.create_coldkey(
+    name="my_hippius_coldkey",  # Optional custom name
+    mnemonic="your mnemonic phrase here"  # Optional - will generate if not provided
+)
+
+# Create a hotkey associated with the coldkey
+hotkey = account_manager.create_hotkey(
+    name="my_hippius_hotkey_1",  # Optional custom name
+    coldkey_address=coldkey["address"]  # Optional association
+)
+
+# List all coldkeys
+coldkeys = account_manager.list_coldkeys()
+
+# List hotkeys for a specific coldkey
+hotkeys = account_manager.list_hotkeys(coldkey_address=coldkey["address"])
+
+# Create a proxy relationship on the blockchain
+result = account_manager.create_proxy_relationship(
+    coldkey_address=coldkey["address"],
+    hotkey_address=hotkey["address"],
+    proxy_type="NonTransfer",  # Type of permissions granted
+    delay=0  # Blocks before proxy becomes active
+)
+
+# List proxy relationships
+proxies = account_manager.list_proxies(coldkey_address=coldkey["address"])
+
+# Remove a proxy relationship
+result = account_manager.remove_proxy(
+    coldkey_address=coldkey["address"],
+    hotkey_address=hotkey["address"]
+)
+```
+
+### CLI Commands for Account Management
+
+The SDK provides CLI commands for managing accounts:
+
+```bash
+# Create a coldkey
+hippius account coldkey create --name "my_hippius_coldkey" --generate-mnemonic --show-mnemonic
+
+# Create a hotkey and associate with a coldkey
+hippius account hotkey create --name "my_hippius_hotkey_1" --coldkey [COLDKEY_ADDRESS]
+
+# List accounts
+hippius account list coldkey --verbose
+hippius account list hotkey
+hippius account list proxy --coldkey [COLDKEY_ADDRESS]
+
+# Create a proxy relationship on the blockchain
+hippius account proxy create --coldkey [COLDKEY_ADDRESS] --hotkey [HOTKEY_ADDRESS] --proxy-type NonTransfer
+
+# Remove a proxy relationship
+hippius account proxy remove --coldkey [COLDKEY_ADDRESS] --hotkey [HOTKEY_ADDRESS]
+```
+
+### Best Practices for Account Management
+
+1. **Security**: Keep your coldkey mnemonic secure and never share it. This is the master key to your account.
+
+2. **Proxy Types**: Different proxy types grant different permissions:
+   - `NonTransfer`: Can perform operations except transferring funds
+   - Other types may be available depending on the chain configuration
+
+3. **Multiple Hotkeys**: Create separate hotkeys for different applications or services to limit the impact if one is compromised.
+
+4. **Regular Auditing**: Regularly check your proxy relationships using `hippius account list proxy` to ensure only authorized delegates have access.
+

{hippius-0.1.7 → hippius-0.1.10}/README.md

@@ -36,7 +36,7 @@ client = HippiusClient()
 # Or specify custom endpoints
 client = HippiusClient(
     ipfs_gateway="https://ipfs.io",                       # For downloads (default)
-    ipfs_api_url="https://relay-fr.hippius.network",  # For uploads (default)
+    ipfs_api_url="https://store.hippius.network",  # For uploads (default)
 )
 
 # Upload a file to IPFS
@@ -282,6 +282,64 @@ This command provides detailed information about each erasure-coded file includi
 - Miners storing the file
 - Reconstruction command
 
+The `ec-files` command is optimized for performance through parallel processing and intelligent filtering, making it efficient even with large numbers of files.
+
+#### Performance Considerations
+
+The erasure coding implementation has been optimized for:
+
+1. **Speed**: Parallel processing for file operations
+2. **Memory efficiency**: Files are processed in chunks to minimize memory usage
+3. **Auto-tuning**: Parameters like chunk size are automatically adjusted for small files
+4. **Intelligent filtering**: The system can quickly identify potential erasure-coded files
+
+For extremely large files (>1GB), consider using larger chunk sizes to improve performance:
+
+```bash
+hippius erasure-code large_video.mp4 --chunk-size 10485760  # 10MB chunks
+```
+
+#### Directory Support for Erasure Coding
+
+Hippius SDK now supports applying erasure coding to entire directories:
+
+```bash
+# Apply erasure coding to an entire directory
+hippius erasure-code my_directory/
+
+# The CLI will detect that it's a directory and offer two options:
+# 1. Archive the directory first, then erasure code the archive
+# 2. Apply erasure coding to each file in the directory individually
+```
+
+When choosing the second option, the system will process each file in the directory individually, adjusting parameters like chunk size automatically for small files. A summary of the operation will be displayed, showing:
+- Total files processed
+- Successfully coded files with their metadata CIDs
+- Any files that failed, with error details
+
+To reconstruct a file from erasure-coded chunks:
+
+```bash
+hippius reconstruct QmMetadataCID reconstructed_filename
+```
+
+#### Default Address Management
+
+Hippius SDK now allows setting a default address for read-only operations, making it easier to use commands like `files` and `ec-files` without specifying an account address each time:
+
+```bash
+# Set a default address for read-only operations
+hippius address set-default 5H1QBRF7T7dgKwzVGCgS4wioudvMRf9K4NEDzfuKLnuyBNzH
+
+# View the currently set default address
+hippius address get-default
+
+# Clear the default address
+hippius address clear-default
+```
+
+Once a default address is set, commands like `hippius files` and `hippius ec-files` will automatically use this address when no explicit address is provided.
+
 #### Troubleshooting
 
 1. **IPFS Connection Issues**: Make sure you have either:
@@ -302,7 +360,30 @@ This command provides detailed information about each erasure-coded file includi
    which hippius
    ```
 
-4. **Substrate Issues**: For marketplace operations, make sure your `.env` has the correct `SUBSTRATE_SEED_PHRASE` and `SUBSTRATE_URL` values.
+4. **Default Address Issues**: If you receive errors about missing account address:
+   ```bash
+   # Set a default address for read-only operations
+   hippius address set-default 5H1QBRF7T7dgKwzVGCgS4wioudvMRf9K4NEDzfuKLnuyBNzH
+   ```
+
+5. **Substrate Issues**: For marketplace operations, make sure your `.env` has the correct `SUBSTRATE_SEED_PHRASE` and `SUBSTRATE_URL` values.
+
+6. **Erasure Coding Problems**:
+   - **"Wrong length for input blocks"**: This typically happens with very small files
+     ```bash
+     # Try smaller k and m values for small files
+     hippius erasure-code small_file.txt --k 2 --m 3
+     ```
+   - **Directories can't be directly coded**: Use the directory support option when prompted
+   - **"zfec is required"**: Install the missing package
+     ```bash
+     pip install zfec
+     poetry add zfec
+     ```
+   - **Slow performance with large files**: Increase chunk size
+     ```bash
+     hippius erasure-code large_file.mp4 --chunk-size 5242880  # 5MB chunks
+     ```
 
 ## Command Line Interface
 
@@ -315,7 +396,7 @@ The Hippius SDK includes a powerful command-line interface (CLI) that provides a
 hippius --help
 
 # Set global options
-hippius --gateway https://ipfs.io --api-url https://relay-fr.hippius.network --verbose
+hippius --gateway https://ipfs.io --api-url https://store.hippius.network --verbose
 ```
 
 ### IPFS Operations
@@ -400,7 +481,7 @@ hippius ec-files --all-miners
 hippius ec-files --show-chunks
 ```
 
-The `ec-files` command makes it easy to track and manage your erasure-coded files separately from regular files. It provides the metadata CID needed for reconstruction and information about chunk distribution.
+The `ec-files` command has been optimized for performance and can now handle large numbers of files efficiently through parallel processing.
 
 ### Using Environment Variables
 
@@ -408,7 +489,7 @@ The CLI automatically reads from your `.env` file for common settings:
 
 ```
 IPFS_GATEWAY=https://ipfs.io
-IPFS_API_URL=https://relay-fr.hippius.network
+IPFS_API_URL=https://store.hippius.network
 SUBSTRATE_URL=wss://rpc.hippius.network
 SUBSTRATE_SEED_PHRASE="your twelve word seed phrase..."
 SUBSTRATE_DEFAULT_MINERS=miner1,miner2,miner3
@@ -515,13 +596,14 @@ The configuration is organized in the following sections:
 {
   "ipfs": {
     "gateway": "https://ipfs.io",
-    "api_url": "https://relay-fr.hippius.network",
+    "api_url": "https://store.hippius.network",
     "local_ipfs": false
   },
   "substrate": {
     "url": "wss://rpc.hippius.network",
     "seed_phrase": null,
-    "default_miners": []
+    "default_miners": [],
+    "default_address": null
   },
   "encryption": {
     "encrypt_by_default": false,
@@ -706,7 +788,13 @@ hippius --help
    which hippius
    ```
 
-4. **Substrate Issues**: For marketplace operations, make sure your `.env` has the correct `SUBSTRATE_SEED_PHRASE` and `SUBSTRATE_URL` values.
+4. **Default Address Issues**: If you receive errors about missing account address:
+   ```bash
+   # Set a default address for read-only operations
+   hippius address set-default 5H1QBRF7T7dgKwzVGCgS4wioudvMRf9K4NEDzfuKLnuyBNzH
+   ```
+
+5. **Substrate Issues**: For marketplace operations, make sure your `.env` has the correct `SUBSTRATE_SEED_PHRASE` and `SUBSTRATE_URL` values.
 
 ## Contributing
 
@@ -823,3 +911,95 @@ client = HippiusClient(
 ```
 
 The multi-account system makes it easier to manage multiple identities while maintaining security and convenience.
+
+## Blockchain Account Management
+
+Hippius SDK provides a comprehensive solution for managing blockchain accounts, including coldkeys, hotkeys, and proxy relationships.
+
+### Coldkeys and Hotkeys
+
+Hippius uses a hierarchical account structure:
+
+- **Coldkey**: The main account that holds your funds and grants permissions
+- **Hotkey**: Delegated accounts that can perform specific actions on behalf of your coldkey
+
+This separation provides enhanced security by allowing you to keep your main account (coldkey) secure while using hotkeys for day-to-day operations.
+
+### Creating and Managing Accounts
+
+```python
+from hippius_sdk.account import AccountManager
+
+# Initialize the account manager
+account_manager = AccountManager()
+
+# Create a coldkey (main account)
+coldkey = account_manager.create_coldkey(
+    name="my_hippius_coldkey",  # Optional custom name
+    mnemonic="your mnemonic phrase here"  # Optional - will generate if not provided
+)
+
+# Create a hotkey associated with the coldkey
+hotkey = account_manager.create_hotkey(
+    name="my_hippius_hotkey_1",  # Optional custom name
+    coldkey_address=coldkey["address"]  # Optional association
+)
+
+# List all coldkeys
+coldkeys = account_manager.list_coldkeys()
+
+# List hotkeys for a specific coldkey
+hotkeys = account_manager.list_hotkeys(coldkey_address=coldkey["address"])
+
+# Create a proxy relationship on the blockchain
+result = account_manager.create_proxy_relationship(
+    coldkey_address=coldkey["address"],
+    hotkey_address=hotkey["address"],
+    proxy_type="NonTransfer",  # Type of permissions granted
+    delay=0  # Blocks before proxy becomes active
+)
+
+# List proxy relationships
+proxies = account_manager.list_proxies(coldkey_address=coldkey["address"])
+
+# Remove a proxy relationship
+result = account_manager.remove_proxy(
+    coldkey_address=coldkey["address"],
+    hotkey_address=hotkey["address"]
+)
+```
+
+### CLI Commands for Account Management
+
+The SDK provides CLI commands for managing accounts:
+
+```bash
+# Create a coldkey
+hippius account coldkey create --name "my_hippius_coldkey" --generate-mnemonic --show-mnemonic
+
+# Create a hotkey and associate with a coldkey
+hippius account hotkey create --name "my_hippius_hotkey_1" --coldkey [COLDKEY_ADDRESS]
+
+# List accounts
+hippius account list coldkey --verbose
+hippius account list hotkey
+hippius account list proxy --coldkey [COLDKEY_ADDRESS]
+
+# Create a proxy relationship on the blockchain
+hippius account proxy create --coldkey [COLDKEY_ADDRESS] --hotkey [HOTKEY_ADDRESS] --proxy-type NonTransfer
+
+# Remove a proxy relationship
+hippius account proxy remove --coldkey [COLDKEY_ADDRESS] --hotkey [HOTKEY_ADDRESS]
+```
+
+### Best Practices for Account Management
+
+1. **Security**: Keep your coldkey mnemonic secure and never share it. This is the master key to your account.
+
+2. **Proxy Types**: Different proxy types grant different permissions:
+   - `NonTransfer`: Can perform operations except transferring funds
+   - Other types may be available depending on the chain configuration
+
+3. **Multiple Hotkeys**: Create separate hotkeys for different applications or services to limit the impact if one is compromised.
+
+4. **Regular Auditing**: Regularly check your proxy relationships using `hippius account list proxy` to ensure only authorized delegates have access.

{hippius-0.1.7 → hippius-0.1.10}/hippius_sdk/__init__.py

@@ -4,6 +4,8 @@ Hippius SDK - Python interface for Hippius blockchain storage
 
 from hippius_sdk.client import HippiusClient
 from hippius_sdk.ipfs import IPFSClient
+from hippius_sdk.substrate import SubstrateClient
+from hippius_sdk.account import AccountManager
 from hippius_sdk.config import (
     get_config_value,
     set_config_value,
@@ -29,6 +31,8 @@ __version__ = "0.1.0"
 __all__ = [
     "HippiusClient",
     "IPFSClient",
+    "SubstrateClient",
+    "AccountManager",
     "get_config_value",
     "set_config_value",
     "get_encryption_key",