hippius 0.2.16__py3-none-any.whl → 0.2.17__py3-none-any.whl

{hippius-0.2.16.dist-info → hippius-0.2.17.dist-info}/METADATA

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

{hippius-0.2.16.dist-info → hippius-0.2.17.dist-info}/RECORD

@@ -1,4 +1,4 @@
-hippius_sdk/__init__.py,sha256=_IVrnzwEOPA6XHWY3wyp07kK2Y761ScXvBRTlqqxF_E,1392
+hippius_sdk/__init__.py,sha256=HHYt8QWs75kFrAVpKrmE1DyKQF96FXt8dpqXamzuDE0,1392
 hippius_sdk/cli.py,sha256=aqKOYSBSWt7UhcpFt7wf9yIPJ3bznpsJ6ehOnuZ4usI,18235
 hippius_sdk/cli_assets.py,sha256=V3MX63QTiex6mCp0VDXQJ7cagm5v1s4xtsu8c1O4G_k,371
 hippius_sdk/cli_handlers.py,sha256=TQNE9os87gRzRKLEO-SIwhFnBtEFMiaSESv-Bu7omfo,128909
@@ -6,13 +6,18 @@ hippius_sdk/cli_parser.py,sha256=z7UvgWvvy04ey-R56qZiCqYc_9RaNq1rVDkQyXoK3JU,211
 hippius_sdk/cli_rich.py,sha256=_jTBYMdHi2--fIVwoeNi-EtkdOb6Zy_O2TUiGvU3O7s,7324
 hippius_sdk/client.py,sha256=W1aVyvgMXRXVqjwSmRl03kZKB96PHMPcpq3cj1equ-8,20179
 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
+hippius_sdk/db/migrations/20241201000001_create_key_storage_tables.sql,sha256=mi4-6OofgsmJq3PTG4ew8VNucoeb7iejyqd-bado7Mc,1613
+hippius_sdk/db/setup_database.sh,sha256=5Nc0VJ4WClxARGB2r7S5bvJVDgtyND3BXnhLLPc4Nto,2929
+hippius_sdk/db_utils.py,sha256=-x0rbN0as7Tn3PJPZBYCgreZe52FLH40ppA1TLxsg90,1851
 hippius_sdk/errors.py,sha256=LScJJmawVAx7aRzqqQguYSkf9iazSjEQEBNlD_GXZ6Y,1589
 hippius_sdk/ipfs.py,sha256=by45dH1c2IxzkfU7B9-ZRkI5gwEAxE0bUB9KUhszlL8,84460
 hippius_sdk/ipfs_core.py,sha256=eOOgLoyP9mvwndnCjldnTc7z94ImYCXY3nm7JU3e_Mo,12676
 hippius_sdk/key_storage.py,sha256=7q5SL3Ls6Ho0xEwYSBpdci7e-bBMJnUMz2j7ROEBSVc,8947
 hippius_sdk/substrate.py,sha256=AqfQNl5Qv_s6roOESSdwleX0-VGyu5sh3m5-dYZp5ek,49079
 hippius_sdk/utils.py,sha256=rJ611yvwKSyiBpYU3w-SuyQxoghMGU-ePuslrPv5H5g,7388
-hippius-0.2.16.dist-info/METADATA,sha256=OMMWMEVBJ-QoTPjHgD0aCVimfs_y_ByECpmK11CbMMw,30088
-hippius-0.2.16.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-hippius-0.2.16.dist-info/entry_points.txt,sha256=b1lo60zRXmv1ud-c5BC-cJcAfGE5FD4qM_nia6XeQtM,98
-hippius-0.2.16.dist-info/RECORD,,
+hippius-0.2.17.dist-info/METADATA,sha256=wgS8li7sLw3RX9gQl3R6g4vj2Qfolg0IAf8UXBMNA6w,30088
+hippius-0.2.17.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+hippius-0.2.17.dist-info/entry_points.txt,sha256=bFAZjW3vndretf9-8s587jA2ebMVI7puhn_lVs8jPc8,149
+hippius-0.2.17.dist-info/RECORD,,

{hippius-0.2.16.dist-info → hippius-0.2.17.dist-info}/entry_points.txt

@@ -1,4 +1,5 @@
 [console_scripts]
 hippius=hippius_sdk.cli:main
 hippius-keygen=hippius_sdk.cli:key_generation_cli
+hippius-setup-db=hippius_sdk.db_utils:setup_db_cli
 

hippius_sdk/__init__.py

@@ -26,7 +26,7 @@ from hippius_sdk.config import (
 from hippius_sdk.ipfs import IPFSClient
 from hippius_sdk.utils import format_cid, format_size, hex_to_ipfs_cid
 
-__version__ = "0.2.16"
+__version__ = "0.2.17"
 __all__ = [
     "HippiusClient",
     "IPFSClient",

hippius_sdk/db/README.md

@@ -0,0 +1,86 @@
+# Database Migrations for Hippius Key Storage
+
+This directory contains database migrations for the Hippius SDK key storage feature.
+
+## Setup for End Users
+
+If you've installed hippius-sdk as a dependency, you can set up the database files in your project:
+
+```bash
+# Copy database files to your project
+hippius-setup-db
+
+# Edit the database URL
+cp env.db.template .env.db
+# Edit .env.db with your database credentials
+
+# Run the setup
+./setup_database.sh
+```
+
+## Development Setup
+
+1. **Install dbmate**:
+   ```bash
+   brew install dbmate
+   # or download directly
+   curl -fsSL -o /usr/local/bin/dbmate https://github.com/amacneil/dbmate/releases/latest/download/dbmate-macos-amd64
+   chmod +x /usr/local/bin/dbmate
+   ```
+
+2. **Run the setup script**:
+   ```bash
+   ./setup_database.sh
+   ```
+
+## Manual Setup
+
+If you prefer to run migrations manually:
+
+```bash
+# Set database URL
+export DATABASE_URL=postgresql://postgres:postgres@localhost:5432/hippius_keys?sslmode=disable
+
+# Create database
+createdb hippius_keys
+
+# Run migrations
+dbmate up
+
+# Configure SDK
+hippius config set key_storage database_url "postgresql://postgres:postgres@localhost:5432/hippius_keys?sslmode=disable"
+hippius config set key_storage enabled true
+```
+
+## Database Schema
+
+### Tables
+
+- **`seed_phrases`**: Stores hashed seed phrases with base64 encoded values
+- **`encryption_keys`**: Stores versioned encryption keys per seed phrase (never deleted)
+
+### Key Features
+
+- **Versioned keys**: New keys create new rows, old keys are never deleted
+- **Efficient lookups**: Index on `(seed_hash, created_at DESC)` for fast retrieval of latest key
+- **Secure storage**: Seed phrases are hashed for indexing, stored base64 encoded
+- **Foreign key constraints**: Ensures data integrity between tables
+
+## Migration Commands
+
+```bash
+# Check migration status
+dbmate status
+
+# Create new migration
+dbmate new migration_name
+
+# Run migrations
+dbmate up
+
+# Rollback last migration
+dbmate down
+
+# Reset database (drop and recreate)
+dbmate drop && dbmate up
+```

hippius_sdk/db/env.db.template

@@ -0,0 +1,9 @@
+# Database connection parameters for Hippius key storage
+# Edit these values to match your PostgreSQL setup
+
+DB_HOST=localhost
+DB_PORT=5432
+DB_USER=postgres
+DB_PASSWORD=postgres
+DB_NAME=hippius_keys
+DB_SSLMODE=disable

hippius_sdk/db/migrations/20241201000001_create_key_storage_tables.sql

@@ -0,0 +1,37 @@
+-- migrate:up
+
+-- Table to store base64 encoded seed phrases (hashed for indexing)
+CREATE TABLE seed_phrases (
+    id SERIAL PRIMARY KEY,
+    seed_hash VARCHAR(64) UNIQUE NOT NULL,
+    seed_phrase_b64 TEXT NOT NULL,
+    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Table to store encryption keys associated with each seed phrase (versioned, never deleted)
+CREATE TABLE encryption_keys (
+    id SERIAL PRIMARY KEY,
+    seed_hash VARCHAR(64) NOT NULL,
+    encryption_key_b64 TEXT NOT NULL,
+    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+    FOREIGN KEY (seed_hash) REFERENCES seed_phrases(seed_hash) ON DELETE CASCADE
+);
+
+-- Index for efficient lookups of latest encryption key per seed phrase
+CREATE INDEX idx_encryption_keys_seed_hash_created 
+ON encryption_keys(seed_hash, created_at DESC);
+
+-- Comments for documentation
+COMMENT ON TABLE seed_phrases IS 'Stores hashed seed phrases with base64 encoded values';
+COMMENT ON TABLE encryption_keys IS 'Stores versioned encryption keys per seed phrase (never deleted, always use most recent)';
+COMMENT ON COLUMN seed_phrases.seed_hash IS 'SHA-256 hash of the seed phrase for indexing';
+COMMENT ON COLUMN seed_phrases.seed_phrase_b64 IS 'Base64 encoded seed phrase';
+COMMENT ON COLUMN encryption_keys.seed_hash IS 'Reference to the seed phrase hash';
+COMMENT ON COLUMN encryption_keys.encryption_key_b64 IS 'Base64 encoded encryption key';
+
+-- migrate:down
+
+-- Drop tables in reverse order due to foreign key constraints
+DROP INDEX IF EXISTS idx_encryption_keys_seed_hash_created;
+DROP TABLE IF EXISTS encryption_keys;
+DROP TABLE IF EXISTS seed_phrases;

hippius_sdk/db/setup_database.sh

@@ -0,0 +1,84 @@
+#!/bin/bash
+# Database setup script for Hippius key storage
+
+set -e
+
+echo "🗄️  Setting up Hippius key storage database..."
+
+# Check if .env.db exists, if not create from template
+if [ ! -f .env.db ]; then
+    if [ -f hippius_sdk/db/env.db.template ]; then
+        echo "📋 Creating .env.db from template..."
+        cp hippius_sdk/db/env.db.template .env.db
+        echo "✏️  Please edit .env.db with your database credentials"
+    elif [ -f env.db.template ]; then
+        cp env.db.template .env.db
+        echo "✏️  Please edit .env.db with your database credentials"
+    else
+        echo "❌ No .env.db file found and no template available"
+        echo "Please create .env.db with your database connection parameters:"
+        echo "DB_HOST=localhost"
+        echo "DB_PORT=5432"
+        echo "DB_USER=postgres"
+        echo "DB_PASSWORD=your_password"
+        echo "DB_NAME=hippius_keys"
+        echo "DB_SSLMODE=disable"
+        exit 1
+    fi
+fi
+
+# Load database connection parameters from env file
+source .env.db
+
+echo "📊 Database connection details:"
+echo "  Host: $DB_HOST"
+echo "  Port: $DB_PORT"
+echo "  User: $DB_USER"
+echo "  Database: $DB_NAME"
+echo "  SSL Mode: $DB_SSLMODE"
+
+# Construct DATABASE_URL for dbmate
+export DATABASE_URL="postgresql://$DB_USER:$DB_PASSWORD@$DB_HOST:$DB_PORT/$DB_NAME?sslmode=$DB_SSLMODE"
+
+# Create database if it doesn't exist
+echo "📝 Creating database $DB_NAME..."
+PGPASSWORD=$DB_PASSWORD createdb -h $DB_HOST -p $DB_PORT -U $DB_USER $DB_NAME 2>/dev/null || echo "Database $DB_NAME already exists"
+
+# Run migrations with dbmate
+echo "🚀 Running database migrations..."
+if command -v dbmate &> /dev/null; then
+    dbmate up
+    echo "✅ Database migrations completed successfully!"
+else
+    echo "❌ dbmate not found. Please install it first:"
+    echo "   brew install dbmate"
+    echo "   # or"
+    echo "   curl -fsSL -o /usr/local/bin/dbmate https://github.com/amacneil/dbmate/releases/latest/download/dbmate-linux-amd64"
+    echo "   chmod +x /usr/local/bin/dbmate"
+    exit 1
+fi
+
+# Configure Hippius SDK to use the database
+echo "⚙️  Configuring Hippius SDK..."
+if [ -f venv/bin/activate ]; then
+    source venv/bin/activate
+    python -c "
+from hippius_sdk.config import set_config_value
+set_config_value('key_storage', 'database_url', '$DATABASE_URL')
+set_config_value('key_storage', 'enabled', True)
+print('✅ Hippius SDK configured for key storage')
+"
+else
+    echo "⚠️  No virtual environment found. Please configure manually:"
+    echo "hippius config set key_storage database_url '$DATABASE_URL'"
+    echo "hippius config set key_storage enabled true"
+fi
+
+echo "🎉 Setup complete! Key storage is ready to use."
+echo ""
+echo "📋 What was set up:"
+echo "   - Database: hippius_keys"
+echo "   - Tables: seed_phrases, encryption_keys"
+echo "   - SDK config: key_storage enabled"
+echo ""
+echo "🧪 Test with: python test_key_storage.py"

hippius_sdk/db_utils.py

@@ -0,0 +1,59 @@
+"""
+Database utilities for Hippius SDK key storage.
+"""
+
+import shutil
+from pathlib import Path
+
+
+def get_db_path() -> Path:
+    """Get the path to the database files."""
+    return Path(__file__).parent / "db"
+
+
+def setup_db_cli() -> None:
+    """CLI command to set up database files in current directory."""
+    db_path = get_db_path()
+
+    print("🗄️  Setting up Hippius database files...")
+
+    # Copy database files to current directory
+    current_dir = Path.cwd()
+
+    # Copy migrations to hippius_s3/sql/sdk_migrations
+    migrations_dest = current_dir / "hippius_s3" / "sql" / "sdk_migrations"
+    migrations_dest.mkdir(parents=True, exist_ok=True)
+
+    migrations_src = db_path / "migrations"
+    if migrations_src.exists():
+        for migration_file in migrations_src.glob("*.sql"):
+            shutil.copy2(migration_file, migrations_dest)
+        print(f"📁 Copied migrations to {migrations_dest}")
+
+    # Copy setup script
+    setup_script_src = db_path / "setup_database.sh"
+    setup_script_dest = current_dir / "setup_database.sh"
+    if setup_script_src.exists():
+        shutil.copy2(setup_script_src, setup_script_dest)
+        setup_script_dest.chmod(0o755)
+        print(f"🔧 Copied setup script to {setup_script_dest}")
+
+    # Copy env template
+    env_template_src = db_path / "env.db.template"
+    env_template_dest = current_dir / "env.db.template"
+    if env_template_src.exists():
+        shutil.copy2(env_template_src, env_template_dest)
+        print(f"📝 Copied env template to {env_template_dest}")
+
+    print()
+    print("✅ Database setup files copied successfully!")
+    print()
+    print("🚀 Next steps:")
+    print(
+        "  1. Copy env.db.template to .env.db and edit with your database credentials"
+    )
+    print("  2. Run: ./setup_database.sh")
+
+
+if __name__ == "__main__":
+    setup_db_cli()