Merge pull request #6 from AIBlockOfficial/ci/publish-pypi

Release 0.2.9: Consistent IResult handling, AIBLOCK_* env vars, docs/CI updates

Author: BarryBoot

.github/workflows/publish.yml

@@ -9,6 +9,20 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - name: Run tests
+        run: |
+          ~/.local/bin/uv pip install -q pytest requests-mock
+          ~/.local/bin/uv run pytest -q
+
   build-and-publish:
     name: Build and publish
     runs-on: ubuntu-latest
@@ -36,5 +50,6 @@ jobs:
         with:
           password: ${{ secrets.PYPI_API_TOKEN }}
           skip-existing: true
+    needs: [test]
 
 

CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## 0.2.9
+
+- Consistent network error handling across `BlockchainClient` and `Wallet` (IResult everywhere)
+- `Wallet.get_balance` now returns `IResult[dict]` (breaking)
+- Unified headers and response handling via shared helpers
+- Added `NetworkNotInitialized` error
+- Docs updated for IResult usage and error mappings
+- CI: added test job and publish-on-main with PyPI token
+- Config: standardized environment variables to `AIBLOCK_*` (`AIBLOCK_MEMPOOL_HOST`, `AIBLOCK_STORAGE_HOST`, `AIBLOCK_PASSPHRASE`, optional `AIBLOCK_VALENCE_HOST`)
+
+## 0.2.8
+
+- Docs refresh and minor fixes
+

README.md

@@ -68,6 +68,8 @@ config = {
 result = wallet.from_seed(seed_phrase, config)
 if result.is_ok:
     print(f"Wallet address: {wallet.get_address()}")
+else:
+    print(result.error, result.error_message)
 ```
 
 ## Features
@@ -110,15 +112,14 @@ if result.is_ok:
     data = result.get_ok()
     print(f"Success: {data}")
 else:
-    print(f"Error: {result.error_message}")
+    print(result.error, result.error_message)
 ```
 
 ## Development
 
 1. Clone the repository
-2. Install dependencies: `pip install -r requirements.txt`
-3. Install test dependencies: `pip install -r requirements-test.txt`
-4. Run tests: `pytest`
+2. Install uv (https://docs.astral.sh/uv/)
+3. Run tests: `uv pip install -q pytest requests-mock && uv run pytest -q`
 
 All 68 tests pass, ensuring reliability and compatibility.
 

aiblock/__init__.py

@@ -23,7 +23,7 @@
     construct_address
 )
 
-__version__ = "0.2.8"
+__version__ = "0.2.9"
 
 __all__ = [
     'BlockchainClient',

aiblock/blockchain.py

@@ -10,6 +10,7 @@
 import random
 from urllib.parse import urlparse
 from aiblock.interfaces import IResult, IErrorInternal
+from importlib import metadata as _importlib_metadata
 import json
 
 # Set up logging
@@ -91,7 +92,9 @@ def handle_response(response) -> IResult[APIResponse]:
     success_messages = {
         'latest_block': 'Latest block retrieved successfully',
         'block': 'Block retrieved successfully',
+        'block_by_num': 'Block retrieved successfully',
         'blockchain': 'Blockchain entry retrieved successfully',
+        'blockchain_entry': 'Blockchain entry retrieved successfully',
         'total_supply': 'Total supply retrieved successfully',
         'issued_supply': 'Issued supply retrieved successfully'
     }
@@ -174,48 +177,30 @@ def _make_request(self, endpoint: str, method: str = 'GET', data: Any = None) ->
             # Determine which host to use based on endpoint
             if endpoint.startswith(('total_supply', 'issued_supply', 'fetch_balance', 'create_item_asset', 'create_transactions')):
                 if not self.mempool_host:
-                    raise ValueError("Mempool host is required for this endpoint")
+                    return IResult.err(IErrorInternal.NetworkNotInitialized, "Mempool host is required for this endpoint")
                 url = f"{self.mempool_host}/{endpoint}"
             else:
                 if not self.storage_host:
-                    raise ValueError("Storage host is required for this endpoint")
+                    return IResult.err(IErrorInternal.NetworkNotInitialized, "Storage host is required for this endpoint")
                 url = f"{self.storage_host}/{endpoint}"
-            
-            # Prepare headers
-            headers = {
-                'Content-Type': 'application/json',
-                'Accept': 'application/json',
-                'User-Agent': f'AIBlock-Python-SDK/{self._get_version()}',
-                'Request-ID': str(uuid.uuid4()),
-                'Nonce': self._get_random_string(32)
-            }
-            
+
+            # Prepare headers using shared generator
+            headers = get_headers()
+            headers['User-Agent'] = f"AIBlock-Python-SDK/{self._get_version()}"
+
             # Make the request
             if method.upper() == 'POST':
                 if data is not None:
-                    # Use the same format as the working example: requests.request with data parameter
                     payload = json.dumps(data)
                     response = requests.request('POST', url, headers=headers, data=payload, timeout=30)
                 else:
                     response = requests.post(url, headers=headers, timeout=30)
             else:
                 response = requests.get(url, headers=headers, timeout=30)
-            
-            # Handle response
-            if response.status_code == 200:
-                try:
-                    json_response = response.json()
-                    return IResult.ok(APIResponse(**json_response))
-                except (ValueError, json.JSONDecodeError):
-                    return IResult.err(IErrorInternal.InvalidNetworkResponse, f"Invalid JSON response: {response.text}")
-            else:
-                try:
-                    error_response = response.json()
-                    reason = error_response.get('reason', f'HTTP {response.status_code}')
-                    return IResult.err(IErrorInternal.InvalidNetworkResponse, reason)
-                except (ValueError, json.JSONDecodeError):
-                    return IResult.err(IErrorInternal.InvalidNetworkResponse, f"HTTP {response.status_code}: {response.text}")
-                    
+
+            # Delegate response handling to shared handler
+            return handle_response(response)
+
         except requests.exceptions.Timeout:
             return IResult.err(IErrorInternal.NetworkError, "Request timeout")
         except requests.exceptions.ConnectionError:
@@ -327,8 +312,11 @@ def fetch_transactions(self, transaction_hashes: list[str]) -> IResult[APIRespon
         return self._make_request('blockchain_entry', method='POST', data=transaction_hashes)
 
     def _get_version(self) -> str:
-        """Get the SDK version."""
-        return "0.2.7"  # Current version from pyproject.toml
+        """Get the SDK version from installed metadata, fallback to project version."""
+        try:
+            return _importlib_metadata.version('aiblock')
+        except Exception:
+            return "0.2.8"
 
     def _get_random_string(self, length: int) -> str:
         """Generate a random string of specified length."""

aiblock/config.py

@@ -33,9 +33,9 @@ def get_config() -> IResult[Dict[str, str]]:
 
     # Required environment variables
     required_vars = {
-        'MEMPOOL_HOST': 'mempoolHost',
-        'STORAGE_HOST': 'storageHost',
-        'PASSPHRASE': 'passphrase'
+        'AIBLOCK_MEMPOOL_HOST': 'mempoolHost',
+        'AIBLOCK_STORAGE_HOST': 'storageHost',
+        'AIBLOCK_PASSPHRASE': 'passphrase'
     }
 
     # Check for required environment variables

aiblock/interfaces.py

@@ -64,6 +64,7 @@ class IErrorInternal(Enum):
     WalletNotInitialized = auto()
     UnableToFetchBalance = auto()
     UnableToInitializeNetwork = auto()
+    NetworkNotInitialized = auto()
     UnableToGenerateHeaders = auto()
     UnableToGetDebugData = auto()
     NoHostsProvided = auto()