ci: standardize pytest invocation and add security scanning
Some checks failed
Blockchain Synchronization Verification / sync-verification (push) Failing after 8s
CLI Tests / test-cli (push) Successful in 10s
Contract Performance Benchmarks / benchmark-gas-usage (push) Successful in 1m22s
Contract Performance Benchmarks / benchmark-execution-time (push) Successful in 1m11s
Contract Performance Benchmarks / benchmark-throughput (push) Successful in 1m13s
Cross-Chain Functionality Tests / test-cross-chain-sync (push) Failing after 5s
Cross-Chain Functionality Tests / test-cross-chain-transactions (push) Successful in 5s
Cross-Chain Functionality Tests / test-cross-chain-bridge (push) Has been skipped
Cross-Chain Functionality Tests / test-multi-chain-consensus (push) Failing after 3s
Cross-Chain Functionality Tests / aggregate-results (push) Has been skipped
Cross-Node Transaction Testing / transaction-test (push) Successful in 5s
Deploy to Testnet / deploy-testnet (push) Successful in 1m14s
Contract Performance Benchmarks / compare-benchmarks (push) Has been cancelled
Documentation Validation / validate-docs (push) Failing after 10s
Multi-Node Stress Testing / stress-test (push) Has been cancelled
Node Failover Simulation / failover-test (push) Has been cancelled
Security Scanning / security-scan (push) Has been cancelled
Smart Contract Tests / test-solidity (map[name:aitbc-contracts path:contracts]) (push) Has been cancelled
Smart Contract Tests / test-solidity (map[name:aitbc-token path:packages/solidity/aitbc-token]) (push) Has been cancelled
Smart Contract Tests / test-foundry (push) Has been cancelled
Smart Contract Tests / lint-solidity (push) Has been cancelled
Smart Contract Tests / deploy-contracts (push) Has been cancelled
Documentation Validation / validate-policies-strict (push) Successful in 3s
Integration Tests / test-service-integration (push) Failing after 45s
Multi-Chain Island Architecture Tests / test-multi-chain-island (push) Failing after 2s
Multi-Node Blockchain Health Monitoring / health-check (push) Successful in 5s
P2P Network Verification / p2p-verification (push) Successful in 3s
Production Tests / Production Integration Tests (push) Failing after 7s
Python Tests / test-python (push) Failing after 46s
Staking Tests / test-staking-service (push) Failing after 2s
Staking Tests / test-staking-integration (push) Has been skipped
Staking Tests / test-staking-contract (push) Has been skipped
Staking Tests / run-staking-test-runner (push) Has been skipped
Systemd Sync / sync-systemd (push) Successful in 21s
API Endpoint Tests / test-api-endpoints (push) Failing after 12m19s
Some checks failed
Blockchain Synchronization Verification / sync-verification (push) Failing after 8s
CLI Tests / test-cli (push) Successful in 10s
Contract Performance Benchmarks / benchmark-gas-usage (push) Successful in 1m22s
Contract Performance Benchmarks / benchmark-execution-time (push) Successful in 1m11s
Contract Performance Benchmarks / benchmark-throughput (push) Successful in 1m13s
Cross-Chain Functionality Tests / test-cross-chain-sync (push) Failing after 5s
Cross-Chain Functionality Tests / test-cross-chain-transactions (push) Successful in 5s
Cross-Chain Functionality Tests / test-cross-chain-bridge (push) Has been skipped
Cross-Chain Functionality Tests / test-multi-chain-consensus (push) Failing after 3s
Cross-Chain Functionality Tests / aggregate-results (push) Has been skipped
Cross-Node Transaction Testing / transaction-test (push) Successful in 5s
Deploy to Testnet / deploy-testnet (push) Successful in 1m14s
Contract Performance Benchmarks / compare-benchmarks (push) Has been cancelled
Documentation Validation / validate-docs (push) Failing after 10s
Multi-Node Stress Testing / stress-test (push) Has been cancelled
Node Failover Simulation / failover-test (push) Has been cancelled
Security Scanning / security-scan (push) Has been cancelled
Smart Contract Tests / test-solidity (map[name:aitbc-contracts path:contracts]) (push) Has been cancelled
Smart Contract Tests / test-solidity (map[name:aitbc-token path:packages/solidity/aitbc-token]) (push) Has been cancelled
Smart Contract Tests / test-foundry (push) Has been cancelled
Smart Contract Tests / lint-solidity (push) Has been cancelled
Smart Contract Tests / deploy-contracts (push) Has been cancelled
Documentation Validation / validate-policies-strict (push) Successful in 3s
Integration Tests / test-service-integration (push) Failing after 45s
Multi-Chain Island Architecture Tests / test-multi-chain-island (push) Failing after 2s
Multi-Node Blockchain Health Monitoring / health-check (push) Successful in 5s
P2P Network Verification / p2p-verification (push) Successful in 3s
Production Tests / Production Integration Tests (push) Failing after 7s
Python Tests / test-python (push) Failing after 46s
Staking Tests / test-staking-service (push) Failing after 2s
Staking Tests / test-staking-integration (push) Has been skipped
Staking Tests / test-staking-contract (push) Has been skipped
Staking Tests / run-staking-test-runner (push) Has been skipped
Systemd Sync / sync-systemd (push) Successful in 21s
API Endpoint Tests / test-api-endpoints (push) Failing after 12m19s
- Changed pytest calls to use `venv/bin/python -m pytest` with explicit config - Added `--rootdir "$PWD"` and `--import-mode=importlib` for consistent imports - Fixed PYTHONPATH to use absolute paths with $PWD prefix - Added smart contract security scanning for Solidity files - Added Circom circuit security checks for ZK proof circuits - Added ZK proof implementation security validation - Added contracts/** to security scanning workflow
This commit is contained in:
315
docs/api/examples/python-sdk-examples.md
Normal file
315
docs/api/examples/python-sdk-examples.md
Normal file
@@ -0,0 +1,315 @@
|
||||
# Python SDK Examples
|
||||
|
||||
This document provides comprehensive examples for using the AITBC Python SDK.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pip install aitbc-sdk
|
||||
```
|
||||
|
||||
## Basic Setup
|
||||
|
||||
```python
|
||||
import aitbc_sdk
|
||||
|
||||
# Initialize client
|
||||
client = aitbc_sdk.Client(
|
||||
api_key="your-api-key",
|
||||
base_url="http://localhost:8011"
|
||||
)
|
||||
```
|
||||
|
||||
## Job Submission
|
||||
|
||||
### Simple Job Submission
|
||||
|
||||
```python
|
||||
# Submit a simple job
|
||||
job = client.submit_job(
|
||||
payload={
|
||||
"model": "llama2",
|
||||
"prompt": "Hello, world!"
|
||||
},
|
||||
ttl_seconds=900
|
||||
)
|
||||
|
||||
print(f"Job ID: {job.job_id}")
|
||||
print(f"State: {job.state}")
|
||||
```
|
||||
|
||||
### Job with Constraints
|
||||
|
||||
```python
|
||||
# Submit job with GPU constraints
|
||||
from aitbc_sdk import Constraints
|
||||
|
||||
job = client.submit_job(
|
||||
payload={
|
||||
"model": "llama2",
|
||||
"prompt": "Hello, world!"
|
||||
},
|
||||
constraints=Constraints(
|
||||
min_gpu_memory=8,
|
||||
gpu_type="nvidia-rtx-3090"
|
||||
),
|
||||
ttl_seconds=900
|
||||
)
|
||||
```
|
||||
|
||||
### Job with Payment
|
||||
|
||||
```python
|
||||
# Submit job with payment
|
||||
job = client.submit_job(
|
||||
payload={
|
||||
"model": "llama2",
|
||||
"prompt": "Hello, world!"
|
||||
},
|
||||
payment_amount=100.0,
|
||||
payment_currency="AITBC",
|
||||
ttl_seconds=900
|
||||
)
|
||||
|
||||
print(f"Payment ID: {job.payment_id}")
|
||||
```
|
||||
|
||||
## Job Status Monitoring
|
||||
|
||||
### Get Job Status
|
||||
|
||||
```python
|
||||
# Get current job status
|
||||
status = client.get_job(job_id="your-job-id")
|
||||
print(f"State: {status.state}")
|
||||
print(f"Assigned Miner: {status.assigned_miner_id}")
|
||||
print(f"Error: {status.error}")
|
||||
```
|
||||
|
||||
### Poll for Completion
|
||||
|
||||
```python
|
||||
import time
|
||||
|
||||
job_id = "your-job-id"
|
||||
|
||||
while True:
|
||||
status = client.get_job(job_id)
|
||||
print(f"State: {status.state}")
|
||||
|
||||
if status.state in ["COMPLETED", "FAILED", "CANCELLED", "EXPIRED"]:
|
||||
break
|
||||
|
||||
time.sleep(5)
|
||||
```
|
||||
|
||||
### WebSocket for Real-time Updates
|
||||
|
||||
```python
|
||||
# Monitor job status via WebSocket
|
||||
def on_status_update(update):
|
||||
print(f"Status update: {update}")
|
||||
|
||||
client.watch_job(job_id="your-job-id", callback=on_status_update)
|
||||
```
|
||||
|
||||
## Job Results
|
||||
|
||||
### Get Job Result
|
||||
|
||||
```python
|
||||
# Get job result
|
||||
result = client.get_job_result(job_id="your-job-id")
|
||||
print(f"Output: {result.result}")
|
||||
print(f"Receipt: {result.receipt}")
|
||||
```
|
||||
|
||||
### Get Receipts
|
||||
|
||||
```python
|
||||
# Get latest receipt
|
||||
receipt = client.get_receipt(job_id="your-job-id")
|
||||
print(f"Signature: {receipt.signature}")
|
||||
|
||||
# Get all receipts
|
||||
receipts = client.list_receipts(job_id="your-job-id")
|
||||
for receipt in receipts:
|
||||
print(f"Receipt: {receipt.signature}")
|
||||
```
|
||||
|
||||
## Job Cancellation
|
||||
|
||||
```python
|
||||
# Cancel a job
|
||||
cancelled_job = client.cancel_job(job_id="your-job-id")
|
||||
print(f"State: {cancelled_job.state}")
|
||||
```
|
||||
|
||||
## Payment Operations
|
||||
|
||||
### Get Payment Status
|
||||
|
||||
```python
|
||||
# Get payment information
|
||||
payment = client.get_payment(job_id="your-job-id")
|
||||
print(f"Status: {payment.status}")
|
||||
print(f"Amount: {payment.amount}")
|
||||
```
|
||||
|
||||
## Blockchain Operations
|
||||
|
||||
### Initialize Blockchain Client
|
||||
|
||||
```python
|
||||
blockchain = aitbc_sdk.BlockchainClient(
|
||||
base_url="http://localhost:8080"
|
||||
)
|
||||
```
|
||||
|
||||
### Get Block Information
|
||||
|
||||
```python
|
||||
# Get head block
|
||||
head_block = blockchain.get_head_block()
|
||||
print(f"Current height: {head_block.height}")
|
||||
|
||||
# Get block by height
|
||||
block = blockchain.get_block(height=12345)
|
||||
print(f"Block hash: {block.hash}")
|
||||
```
|
||||
|
||||
### Network Status
|
||||
|
||||
```python
|
||||
# Get network information
|
||||
network = blockchain.get_network_info()
|
||||
print(f"Peer count: {network.peer_count}")
|
||||
print(f"Chain ID: {network.chain_id}")
|
||||
|
||||
# Get peers
|
||||
peers = blockchain.get_peers()
|
||||
for peer in peers:
|
||||
print(f"Peer: {peer.address}")
|
||||
```
|
||||
|
||||
### Transaction Operations
|
||||
|
||||
```python
|
||||
# Get transaction
|
||||
tx = blockchain.get_transaction(tx_hash="0x...")
|
||||
print(f"From: {tx.from}")
|
||||
print(f"To: {tx.to}")
|
||||
print(f"Value: {tx.value}")
|
||||
```
|
||||
|
||||
## Error Handling
|
||||
|
||||
```python
|
||||
from aitbc_sdk.exceptions import APIError, AuthenticationError
|
||||
|
||||
try:
|
||||
job = client.submit_job(
|
||||
payload={"model": "llama2", "prompt": "Hello"}
|
||||
)
|
||||
except AuthenticationError:
|
||||
print("Invalid API key")
|
||||
except APIError as e:
|
||||
print(f"API error: {e}")
|
||||
except Exception as e:
|
||||
print(f"Unexpected error: {e}")
|
||||
```
|
||||
|
||||
## Advanced Examples
|
||||
|
||||
### Batch Job Submission
|
||||
|
||||
```python
|
||||
# Submit multiple jobs
|
||||
jobs = []
|
||||
for prompt in ["Hello", "World", "Test"]:
|
||||
job = client.submit_job(
|
||||
payload={"model": "llama2", "prompt": prompt},
|
||||
ttl_seconds=900
|
||||
)
|
||||
jobs.append(job)
|
||||
|
||||
print(f"Submitted {len(jobs)} jobs")
|
||||
```
|
||||
|
||||
### Job History
|
||||
|
||||
```python
|
||||
# Get job history
|
||||
history = client.get_job_history(limit=10)
|
||||
for job in history:
|
||||
print(f"Job {job.job_id}: {job.state}")
|
||||
```
|
||||
|
||||
### Custom Headers
|
||||
|
||||
```python
|
||||
# Use custom headers
|
||||
client = aitbc_sdk.Client(
|
||||
api_key="your-api-key",
|
||||
base_url="http://localhost:8011",
|
||||
headers={"X-Custom-Header": "value"}
|
||||
)
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
```python
|
||||
# Mock client for testing
|
||||
from unittest.mock import Mock
|
||||
|
||||
mock_client = Mock()
|
||||
mock_client.submit_job.return_value = Mock(job_id="test-id", state="QUEUED")
|
||||
|
||||
job = mock_client.submit_job(payload={"model": "test"})
|
||||
assert job.job_id == "test-id"
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
### Environment Variables
|
||||
|
||||
```python
|
||||
import os
|
||||
from dotenv import load_dotenv
|
||||
|
||||
load_dotenv()
|
||||
|
||||
client = aitbc_sdk.Client(
|
||||
api_key=os.getenv("AITBC_API_KEY"),
|
||||
base_url=os.getenv("AITBC_BASE_URL", "http://localhost:8011")
|
||||
)
|
||||
```
|
||||
|
||||
### Timeout Configuration
|
||||
|
||||
```python
|
||||
client = aitbc_sdk.Client(
|
||||
api_key="your-api-key",
|
||||
base_url="http://localhost:8011",
|
||||
timeout=30 # 30 second timeout
|
||||
)
|
||||
```
|
||||
|
||||
## Receipt Verification
|
||||
|
||||
```python
|
||||
import aitbc_crypto
|
||||
|
||||
# Verify receipt signature
|
||||
receipt = client.get_receipt(job_id="your-job-id")
|
||||
is_valid = aitbc_crypto.verify_receipt(
|
||||
receipt.signature,
|
||||
receipt.data,
|
||||
public_key="miner-public-key"
|
||||
)
|
||||
|
||||
if is_valid:
|
||||
print("Receipt is valid")
|
||||
else:
|
||||
print("Receipt is invalid")
|
||||
```
|
||||
Reference in New Issue
Block a user